ONoneuptime
API Key

Get API Key

Endpoint to retrieve a single API Key by ID

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

Request

Path parameters

idstring uuid required

ID of the API Key to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": 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,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Production API Key",
    "description": "API key used for production environment monitoring and alerting integrations",
    "slug": "example-slug-value",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "expiresAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "apiKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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