API referenceAutomations

Get automation

Returns one monitoring automation: its rules, actions, frequency, scope and status.

GET
/v1/brands/{brandId}/automations/{automationId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

automationId*string
Match^[1-9]\d*$
Length1 <= length

Response Body

Get automation

application/json
  1. response
[key: string]?unknown
curl -X GET "https://example.com/v1/brands/0/automations/string" \  -H "Authorization: Bearer koast_sk_..."
{  "property1": null,  "property2": null}

Required scope: read. CLI: koast get-automation, see Automations commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.

Save automation

Creates a monitoring automation from the spec in automation, or updates an existing one when automationId is given. On create the spec must be complete (name, actionLevel, actions, frequency, apiOutageAction, rules); on update only the fields you pass are changed.

Delete automation

Permanently deletes the monitoring automation.