Update API auth app

Update an API authentication app

PATCH /api-auth/apps/{app_name}

Update API auth app

cURL

curl --request PATCH \
  --url https://api.wacht.dev/api-auth/apps/{app_name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "is_active": true,
  "rate_limits": [
    {
      "unit": "minute",
      "duration": 1,
      "max_requests": 100,
      "mode": "per_key"
    }
  ]
}
'

200

{
  "id": "1234567890123456789",
  "deployment_id": "9876543210987654321",
  "name": "My App",
  "description": "Production application",
  "is_active": true,
  "rate_limits": [
    {
      "unit": "minute",
      "duration": 1,
      "max_requests": 100,
      "mode": "per_key"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

API key authentication (format: Bearer {api_key})

Path Parameters

app_name · string · required

API Auth app name

Body

application/json

name · string

New app name

description · string

New app description

is_active · boolean

Whether the app is active

rate_limits · object[]

New rate limit rules

Show child attributes

Response

200

application/json

API auth app updated

id · string

App ID

Example:

"1234567890123456789"

deployment_id · string

Deployment ID

Example:

"9876543210987654321"

name · string

App name

Example:

"My App"

description · string | null

App description

Example:

"Production application"

is_active · boolean

Whether the app is active

Example:

true

rate_limits · object[]

Rate limit rules

Show child attributes

created_at · string<date-time>

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

updated_at · string<date-time>

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

deleted_at · string<date-time> | null

Deletion timestamp