Skip to main content
GET
Read an application's proposed setup contract

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id
string
required

Response

Successful Response

The generated setup as recorded on the application: what Ankra detected, what it proposed, and what of it is negotiable. negotiable_options lists the option names a revision may change, so a caller never has to guess and a refusal is never the first thing the user learns.

application_id
string
required
name
string
required
analysis_status
string
required
contract
Application Setup Contract · object
required

The deploy option contract of record. options is populated only when status is "recorded"; on "absent" and "unknown" it is null and reason says which. An application whose contract Ankra cannot read is not an application without a contract, so the two must not be rendered the same way.

database
Application Setup Database · object
required

The database the proposal carries, read off the recorded manifests rather than off the detection that produced them. engine/operator/manifest_path are set only when status is "recorded".

negotiable_options
string[]
required
detected_language
string
detected_framework
string
pull_request_url
string
setup_branch
string