POST
/
api
/
v1
/
stacks
/
analyze
Analyze a compose source
curl --request POST \
  --url https://app.miget.com/api/v1/stacks/analyze \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repository_url": "<string>",
  "branch": "<string>",
  "compose_path": "<string>",
  "resource_id": "<string>",
  "credential_id": "<string>"
}
'
{
  "manifest": {},
  "warnings": [
    "<unknown>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Body

application/json

Analyze a compose source

repository_url
string
required

Git repository URL (GitHub or public HTTPS Git)

branch
string
required

Git branch to analyze

compose_path
string

Path to the docker-compose file within the repository (defaults to '.')

resource_id
string

UUID of the target compute resource (used to derive the detection namespace)

credential_id
string

UUID of a stored Git credential (for private repositories)

Response

Analyze a compose source

Api_V1_Entities_StackAnalysis model

manifest
object
required

Detected compose manifest (apps, standalone_services, managed_services, volumes, defaults)

warnings
any[]
required

Non-fatal detection warnings