ONoneuptime
API Key

Update API Key

Endpoint to update an existing API Key

put/api-key/{id}

Request

Path parameters

idstring uuid required

ID of the API Key to update

Request body

Example request

{
  "data": {
    "name": "Example Text",
    "expiresAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    }
  }
}

Response

Updated successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "description": "This is an example of longer text content that provides detailed information.",
    "slug": "example-slug",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "expiresAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

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