Home
API reference
Platform API reference
Platform API
OAuth API keys
Delete OAuth API key

Delete OAuth API key

delete/v1/apikeys/{apikeyId}
Page View

OAuth API key endpoints allow you to view and manage OAuth API keys for a given environment in your Redox organization. Learn more about OAuth API keys, which is our preferred authentication method.

You can retrieve, create, update, or delete OAuth API keys.

Delete OAuth API key

Delete an existing OAuth API key. There isn't a way to restore a deleted key, so make sure the API key isn't being used before deleting.

The response contains an acknowledgement if the delete is successful.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/apikeys/{apikeyId}' \
2
--request DELETE \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • apikeyId
    required, string

    Displays the unique identifier (i.e., client ID) of the OAuth API key.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "message": "string"
7
  }
8
}

    Describes the outcome of the delete request.

  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object
    • message
      string

      Explains that the delete request was successful, so the OAuth API key no longer exists within the specified environment.