PRpremai-io
API Keys
dev-api

Get an API key

Changed on

Get details of a specific API key by ID

get/developers/api_keys/{id}

Request

  • Base URL
    https://gateway.prem.io
  • Auth
    HTTP bearer and API key in header Authorization

Path parameters

idstring required

API Key ID

Response

Successful API key view response

status200 | 201 | 202 required

Status code of the response

errorstring nullable

Error message of the response, human readable

messagestring nullable required

Message of the response, human readable

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_0197c0ec-a197-719f-84a9-99270a79b42a",
    "secret": "sk_live_MDE5N2MwZWMt...GdwdA",
    "scopes": [
      "api_keys.read"
    ],
    "ip_allow_list": [
      "127.0.0.1",
      "192.168.1.0/24"
    ],
    "label": "My API Key",
    "description": "Key for reading API Keys",
    "expires_at": "2026-05-30 20:23:16",
    "created_at": "2025-06-30 15:00:22",
    "updated_at": "2025-07-01 10:30:45",
    "metrics": {
      "api_key_id": "api_key_0197c0ec-a197-719f-84a9-99270a79b42a",
      "total_requests": 1250,
      "last_used_at": "2025-07-01 09:15:30"
    }
  },
  "message": null
}

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 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 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

    • warning

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

    • info

      removed the BALANCE enum value from the ///// response property for the response status

    • info

      removed the PLAN enum value from the ///// response property for the response status

  • d5b1beb33be5Revision changes
    • info

      endpoint added