Delete API key

GET 
/pim/keydelete/:key

• Requires Access Manager ApiKey permissions.
• Example URI: https://instancename.piminto.com/api/en-us/pim/keydelete/ApiKey

Replace 'ApiKey' with the actual value of the API key you want to remove.

This endpoint allows you to delete the specified API key

Request

Path Parameters

key stringrequired

API key that you wish to DELETE

Responses

200

success

application/json

Schema

Schema

status stringrequired

The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.

status_message stringrequired

Example (from schema)

{
  "status": "OK",
  "status_message": "API key has been deleted."
}

default

If there is an error with the API request, additional information will be provided in the response body.
Examples of error messages include:

"status_message": "API key does not exist or could not be deleted"
"status_message": "Cannot delete your own API key."

application/json

Schema

Schema

status stringrequired

Possible values: [Error]

The status of the API request. A value of "Error" indicates that the request was not successfully sent or processed.

status_message stringrequired

Provides a message that describes the reason for the error that occurred while processing the API request.

Example (from schema)

{
  "status": "Error",
  "status_message": "string"
}

Loading...