API Keys

Validate API Key

Requires a JSON object with these properties:

Note: Requires administrator permissions.

post/_api/key/validate

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/validate/post.ts
A function with typed inputs. Its response is checked against the schema.

apikeystring required

The id of the API key.

{
  "apikey": "test1"
}

Successfully validated API key.

codeinteger

HTTP response code.

errorboolean required

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

{
  "code": 200,
  "result": [
    {
      "keyid": "test",
      "parent": "root",
      "tenant": "_mm"
    }
  ]
}

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