API Key Management

Set or clear the display name of one of your API keys. The key value and its permissions are unchanged.

patch/v1/api-keys/{id}

Request

  • Base URL
    https://api.oilpriceapi.com
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required
Example:018f47a2-4d4d-7a44-9fa4-123456789abc

Resource identifier.

Request body

namestring nullable required

New display name. Blank clears the name.

Example request

{
  "name": "production-ingest"
}

Response

Key renamed

status'success' required
dataobject required

Changes