External key

Get the given external key

    Fetches information about an external_key, optionally returns validation info
get/workspaces/{workspace_id}/external_keys/{key_id}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/external_keys/{key_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
key_idinteger required

Id of an external key

Example:121

Query parameters

fieldsstring

Fields to be returned in a comma-separated format. Check full mode for all fields.

Example:key_type,key_name,created_by_user_id
validateboolean nullable

When True, Validates the key

Example:true

Response

Success

Changes

No recorded changes to this operation across all 4 revisions of this API.