Managed Apps

Managed application deployment endpoints

get

GET /api/v1/managed-apps/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/managed-apps/
get

GET /api/v1/managed-apps/status/{deployment_uuid}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
deployment_uuidstringRequired

Path parameter: deployment_uuid

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/managed-apps/status/{deployment_uuid}
get

GET /api/v1/managed-apps/installation-status/{app_id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
app_idstringRequired

Path parameter: app_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/managed-apps/installation-status/{app_id}
post

POST /api/v1/managed-apps/deploy

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
post
/api/v1/managed-apps/deploy
post

POST /api/v1/managed-apps/retry/{app_id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
app_idstringRequired

Path parameter: app_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/managed-apps/retry/{app_id}
post

POST /api/v1/managed-apps/{id}/configuration

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/managed-apps/{id}/configuration
delete

DELETE /api/v1/managed-apps/{app_id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
app_idstringRequired

Path parameter: app_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/managed-apps/{app_id}
get

GET /api/v1/managed-apps/verify-domain/{app_id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
app_idstringRequired

Path parameter: app_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/managed-apps/verify-domain/{app_id}
post

POST /api/v1/managed-apps/complete-installation/{app_id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
app_idstringRequired

Path parameter: app_id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
domainanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/managed-apps/complete-installation/{app_id}

Last updated