Refresh an overlay key

POST

/v1/overlays/{overlayId}/refresh-key

curl --request POST \
  --url https://api.ligr.live/rest/v1/overlays/1/refresh-key \
  --header 'Authorization: Bearer <token>'

• LIGR REST API

Refresh the overlay key. The previous key stops working immediately.

Authorizations

• bearer
  overlays:write
• api_key
  overlays:write

Parameters

Path Parameters

overlayId

required

Entity identifier

integer format: int32

>= 1

The overlay id

Responses

200

Ok

Media typeapplication/json

object

key

required

Stringified UUIDv4. See RFC 4112

string

/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}/

Example^generated

{
  "key": "example"
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Overlay not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}