PUT
/
api
/
v1
/
csp
/
apikey
/
{secret_key}
Update API Key
curl --request PUT \
  --url https://sandbox.paylias.xyz/gateway/api/v1/csp/apikey/{secret_key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-partner-id: <x-partner-id>' \
  --data '{
  "access": {
    "customers_read": true,
    "customers_write": true,
    "transactions_read": true,
    "transactions_write": true
  },
  "description": "Api key for customer API access",
  "enabled": true,
  "name": "Customers Api Key (Enabled)"
}'
{
  "data": {
    "access": {
      "customers_read": true,
      "customers_write": true,
      "transactions_read": true,
      "transactions_write": true
    },
    "created_at": {
      "seconds": 1692260424
    },
    "description": "Api key for customer API access",
    "enabled": true,
    "name": "Customers Api Key (Enabled)",
    "partner_id": "part_cjes76vsemvj3obsnc30",
    "secret_key": "AB6DBC62DBA42EE52BC3928E772FBE3C",
    "token": "api_cjetgi7semvjct8hhqm0",
    "updated_at": {
      "seconds": 1692260453
    }
  },
  "ok": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-partner-id
string
default:""
required

The Partner ID header used for authorization

idempotency-key
string
default:""
required

The Idempotency Key - usually a UUID

Path Parameters

secret_key
string
required

The API secret key

Example:

"36BFB7C90C7A1D3D4E09E2E2C05DDD3E"

Body

application/json

Request to update an existing API key

The body is of type object.

Response

200
application/json

Response containing API key information

Standard response structure for successful operations