Skip to content
Aura

Get Project Instructions

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

Both instruction blocks in force for this project.

Unlike the deployment view this always answers: “which rules apply here” has an answer even when that answer is neither.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProjectAgentInstructionsResponse

Both blocks in force for a project — the deployment’s, and the project’s own.

Always answerable, unlike the single-resource deployment view: “what instructions apply here” has an answer even when that answer is neither.

object
deployment
required
Any of:
string
project
required
Any of:
string
pulled_from
Any of:
string
Examplegenerated
{
  "deployment": "example",
  "project": "example",
  "pulled_from": "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"
    }
  ]
}