Skip to content
Aura

Get Deployment Instructions

GET
/api/v1/deployments/{name}/instructions
curl --request GET \
  --url https://aura-api-eu.strangeworks.com/api/v1/deployments/example/instructions \
  --header 'Authorization: Bearer <token>'

The deployment’s AGENTS.md — the operating rules its projects pull.

content is null when the deployment ships none; the 404 on this route means the deployment itself is absent, so a caller can tell those two apart.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
Name
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
DeploymentAgentInstructionsResponse

What a deployment currently ships — None when it ships nothing.

Deliberately not a 404: this route’s 404 has to mean “no such deployment”, and overloading it with “no instructions” would leave a client unable to tell an unconfigured deployment from a misspelled name.

object
content
required
Any of:
string
Examplegenerated
{
  "content": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}