Skip to content
TotalView API

Revoke an API key

DELETE
/api/v1/auth/api-keys/{key_id}
 
curl --request DELETE \
  --url https://api.totalview.energy/api/v1/auth/api-keys/example \
  --header 'Authorization: Bearer <token>'

Revoke (deactivate) an API key. The key will no longer authenticate.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key_id
required
Key Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}