Sign in
Bindings

Changed on
get/api/v1/bindings/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

Credential binding id

Response

Binding found (non-secret metadata only)

allowedPurposesCredentialPurpose[] required

The credential purposes this binding is allowed to serve.

forwardIdstring required

The owning forward's stable identifier (the forward name).

idstring required

Stable, non-secret binding identifier.

originstring required

An exact, normalized upstream origin (scheme + host + port).

Normalization lower-cases the scheme and host and makes the port explicit, so that bindings can be matched exactly and credentials are never sent to a different origin because of address-normalization ambiguity.

revisioninteger

Monotonic binding revision. Any change to the binding must bump this so cached credentials for the old revision are never reused.

secretRefsSecretRef[] required

One or more opaque secret references resolved just in time.

Example response

{
  "secretRefs": [
    "env:API_TOKEN"
  ]
}

Changes

  • 31aa06812281Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

  • 169a69a9b248Revision changes
    • info

      endpoint added