Introspection

Check API Key

Checks that your API Key is valid.

Successful requests will return information about the API Key.

post/v1/introspect/api_key

Request

  • Base URL: https://auth.quiltt.io
  • URL: https://auth.quiltt.io/v1/introspect/api_key
  • Auth: HTTP bearer

Response

OK

idstring global_id-v1 required

The ID of the API Key.

namestring required

The name of the API Key.

apiVersionstring required

The Quiltt API Version for this API Key.

metadataobject nullable required

Custom metadata about the API Key, stored in a 'key-value' format.

See the Custom Metadata guide for more information and examples.

Example response

{
  "id": "api_11gKT7OFCTrIx1YA3M0zfS5",
  "metadata": {
    "description": "Used for server-side Authentication and Profile management"
  },
  "environment": {
    "id": "env_1hyoxpVVFib1HngGwKAzIr",
    "name": "Production",
    "mode": "PRODUCTION",
    "metadata": {
      "internalEnvironmentName": "staging"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.