Skip to content
Helmsman
Menu

API reference

Applications API

Applications and their sub-resources: validation, Pipeline copy, Permissions, Extended resources, Quotas, Ownership and chart values.

Access. Signed-in caller or PAT. Reads and writes follow the Application’s Mode; Permission and Ownership changes need a person, not a PAT; releasing a Jail needs org:admin. Publish and unpublish answer 404 unless the server turns them on, and today only record intent.

OpenAPI tag Applications. Paths are relative to the API host.

MethodPathOperation
GET/api/v1/applicationsList applications
POST/api/v1/applicationsCreate an application
GET/api/v1/applications/{id}Get an application
PUT/api/v1/applications/{id}Update an application
DELETE/api/v1/applications/{id}Delete an application
POST/api/v1/applications/{id}/publishPublish an application
POST/api/v1/applications/{id}/unpublishUnpublish an application
POST/api/v1/applications/validateValidate an application body
POST/api/v1/applications/{appId}/pipelines/copyCopy pipelines to an application
POST/api/v1/applications/{appId}/pipelines/updateUpdate an application’s pipelines
GET/api/v1/applications/{appId}/permissionsGet the permission list
PUT/api/v1/applications/{appId}/permissionsReplace the permission list
GET/api/v1/applications/{appId}/extended-resourcesList extended resources
POST/api/v1/applications/{appId}/extended-resourcesAdd an extended resource
DELETE/api/v1/applications/{appId}/extended-resources/{id}Delete an extended resource
GET/api/v1/applications/{appId}/extended-resources/auditList extended resource audit events
GET/api/v1/applications/{appId}/quotasList quotas
GET/api/v1/applications/{appId}/quotas/{cluster}Get the quota on one cluster
PUT/api/v1/applications/{appId}/quotas/{cluster}Set the quota on one cluster
DELETE/api/v1/applications/{appId}/quotas/{cluster}Remove the quota on one cluster
GET/api/v1/applications/{appId}/ownershipList ownership links
POST/api/v1/applications/{appId}/ownershipAdd an ownership link
DELETE/api/v1/applications/{appId}/ownership/{id}Delete an ownership link
GET/api/v1/applications/{appId}/chartsList chart settings
GET/api/v1/applications/{appId}/valuesGet chart values
POST/api/v1/applications/{appId}/charts/updateUpdate chart settings