PRpremai-io
API Keys

Update an API key

Changed on

Update a specific API key by ID

put/developers/api_keys/{id}

Request

  • Base URL
    https://gateway.prem.io
  • Auth
    HTTP bearer

Path parameters

idstring required

API Key ID

Request body

descriptionstring required

Human-readable description for the API key

Example request

{
  "description": "Key for production environment"
}

Response

Successful API key update response

status200 | 201 | 202 required

Status code of the response

errorstring nullable

Error message of the response, human readable

messagestring nullable required

Success message

env'development' | 'production' required

API environment

support_idstring uuid nullable

Support ID linked to the response, used to identify it when talking with our team.

Example response

{
  "data": {
    "id": "api_key_0197c0f1-9589-7990-b421-4b806f637b0c"
  },
  "message": "API key updated"
}

Changes

  • d46bc3931b34Revision changes
    • warning

      added the new 405.00 enum value to the / response property for the response status

    • warning

      added the new 405.00 enum value to the / response property for the response status

    • warning

      added the new 405.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the / response property for the response status

    • warning

      added the new 409.00 enum value to the / response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status

    • warning

      added the new 500.00 enum value to the / response property for the response status

    • warning

      added the new 500.00 enum value to the / response property for the response status

    • warning

      added the new 500.00 enum value to the response property for the response status

  • d5b1beb33be5Revision changes
    • info

      endpoint added