Skip to main content
GET
/
access-key-configurations
/
{id}
Get an AI Gateway access key configuration
curl --request GET \
  --url https://api.ngrok.ai/access-key-configurations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "uri": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "<string>",
    "uri": "<string>"
  },
  "lastUpdatedBy": {
    "id": "<string>",
    "uri": "<string>"
  },
  "description": "<string>",
  "metadata": "<string>",
  "access": {
    "providers": {
      "allow": [
        "<string>"
      ]
    },
    "models": {
      "allow": [
        "<string>"
      ]
    }
  },
  "router": {
    "rules": [
      {
        "steps": [
          {
            "keys": [
              {
                "id": "<string>",
                "name": "<string>",
                "keyRedacted": "<string>"
              }
            ],
            "keySelectionStrategy": "ordered"
          }
        ],
        "provider": "<string>",
        "model": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique identifier for an AI Gateway access key configuration.

Response

The AI Gateway access key configuration.

id
string
required

Unique identifier for this configuration.

uri
string
required

URI of this AI Gateway Access Key Configuration API resource.

name
string
required

User-defined label for this configuration.

createdAt
string<date-time>
required

Timestamp when the configuration was created.

updatedAt
string<date-time>
required

Timestamp when the configuration was last updated.

createdBy
object
required
lastUpdatedBy
object
required
description
string

Human-readable description.

metadata
string

Arbitrary user-defined metadata.

access
object

Scope controlling which providers and models are reachable. Omit the entire object for allow-all. Each dimension is independently optional.

router
object