Skip to content
Nexa Platform Docs

Get Automation State

GET
/api/automations/{automation_alias}/state
curl --request GET \
  --url https://example.com/api/automations/example/state \
  --header 'Authorization: Bearer <token>'

Combined deployment + runtime view for this env. Single round-trip from backend’s detail page. Runtime comes live from Databricks (no Postgres mirror).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
automation_alias
required
Automation Alias
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AutomationStateResponse

Combined deployment + runtime view for the detail page.

object
success
required
Success
boolean
automation_alias
required
Automation Alias
string
deployment
Any of:
object
key
additional properties
any
runtime
Any of:
object
key
additional properties
any
Examplegenerated
{
  "success": true,
  "automation_alias": "example",
  "deployment": {},
  "runtime": {}
}

422

Section titled “422”

Validation Error

Media typeapplication/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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}