API Keys

Get available API key.

Fetch an existing API key, identified by keyid. You can only get your API keys.

get/_api/key/{keyid}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/key/:keyid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

keyidstring string required

The id of the API key.

Response

Successfully fetched API key.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

userstring

The ID of the API key.

displayNamestring

The username of the API key.

activeboolean

Active status the API key.

Example response

{
  "code": 200,
  "user": "Ugr0xjYMS9y0eN5gBxSSmg",
  "displayName": "test1",
  "active": true,
  "apikey": {
    "key": "tenant1_domain.com.test1.6umGXOk34BZDVVGraow0r7CaSy5XOXitaWPvquoX3Dilcyq8upF7RRKGGdPPpiDR741f65",
    "parent": "root"
  }
}

Changes

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