GET
/
vault-forward
/
configs
/
{config_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/vault-forward/configs/{config_id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "vault-forward-config",
  "id": "faaad066-30b4-4997-a438-242b0752d7e1",
  "created_at": "2012-12-12T10:53:43+00:00",
  "updated_at": "2012-12-12T10:53:43+00:00",
  "merchant_account_id": "default",
  "definition_id": "amadeus",
  "display_name": "Amadeus",
  "hosts": [
    "https://api.amadeus.com",
    "https://test.api.amadeus.com"
  ],
  "authentications": [
    {
      "type": "vault-forward-config-authentication",
      "id": "faaad066-30b4-4997-a438-242b0752d7e1",
      "created_at": "2012-12-12T10:53:43+00:00",
      "updated_at": "2012-12-12T10:53:43+00:00",
      "kind": "mle",
      "label": "My MLE",
      "display_name": "My MLE",
      "fields": [
        {
          "key": "secret_key",
          "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
        }
      ],
      "creator": {
        "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
        "name": "John L",
        "email_address": "john@example.com"
      }
    }
  ],
  "creator": {
    "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
    "name": "John L",
    "email_address": "john@example.com"
  }
}

This endpoint requires the vault-forward-configs.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
config_id
string
required

The ID of the Vault Forward configuration.

Example:

"46973e9d-88a7-44a6-abfe-be4ff0134ff4"

Response

200
application/json
Returns the Vault Forward configuration.

A configured Vault Forward configuration.

​
type
string
default:vault-forward-config

The type of this resource. It is always vault-forward-config.

Example:

"vault-forward-config"

​
id
string

The ID of this Vault Forward configuration.

Example:

"faaad066-30b4-4997-a438-242b0752d7e1"

​
created_at
string

The date and time when this configuration was created.

Example:

"2012-12-12T10:53:43+00:00"

​
updated_at
string

The date and time when this configuration was last updated.

Example:

"2012-12-12T10:53:43+00:00"

​
merchant_account_id
string

The unique ID for a merchant account.

Example:

"default"

​
definition_id
string

The ID of the Vault Forward definition.

Example:

"amadeus"

​
display_name
string

The display name for this configuration.

Example:

"Amadeus"

​
hosts
string[]

The hosts where Vault Forward requests are allowed for this definition.

Example:
[
  "https://api.amadeus.com",
  "https://test.api.amadeus.com"
]
​
authentications
object[]

Authentication methods that can be applied in Vault Forward requests.

A configured Vault Forward authentication method.

​
creator
object | null

The user who created the Vault Forward configuration.

Was this page helpful?

Suggest edits
List endpointsGet authentications