ONoneuptime
API Key Permission

Get API Key Permission

Endpoint to retrieve a single API Key Permission by ID

post/api-key-permission/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the API Key Permission to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "apiKeyId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "permission": {
      "read": true,
      "write": false,
      "delete": false
    },
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "isBlockPermission": true,
    "customRoleId": "123e4567-e89b-12d3-a456-426614174000",
    "apiKeyCustomRoleId": "123e4567-e89b-12d3-a456-426614174000",
    "customRolePermissionId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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