Ga naar inhoud
buildinglinksbuildinglinks

Request a connection again

POST
/api/v1/connections/{alias}/retry
curl --request POST \
  --url https://example.com/api/v1/connections/example/retry \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

For a connection that failed, expired or was terminated: negotiates and starts a transfer again under the same alias. The old agreement ends.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
alias
required
string

The alias of the connection: the name in its gateway address.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

What a retry answers.

object
alias
required
string
state
required

negotiating, or transferring for an own subscription.

string

Example generated

{
  "alias": "example",
  "state": "example"
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

409

Section titled “409”

The connection has not ended.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}