Deployed Application

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Deployed Application is contained within a Application.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
applicationId string No
deploymentKey string No
deploymentWebhost string No
host string No
urls array No

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified deployedApplication are granted for a given set of users
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified deployedApplication for the given user
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified deployedApplication are granted for a given set of users
POST /webhosts/{webhostId}/applications/authorities/check

Parameters

Name Required Type Description
webhostId true string The ID of the web host

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified deployedApplication are granted for a given set of users
POST /webhosts/{webhostId}/applications/permissions/check

Parameters

Name Required Type Description
webhostId true string

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Grant Authority

Grants an authority against the specified deployedApplication to a given user
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Deployed Application

Retrieves a list of Deployed Application instances
GET /webhosts/{webhostId}/applications

Parameters

Name Required Type Description
webhostId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployedApplication"
      }
    }
  }
}

Queries for Deployed Application

Queries for matches
POST /webhosts/{webhostId}/applications/query

Parameters

Name Required Type Description
webhostId true string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployedApplication"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified deployedApplication
GET /webhosts/{webhostId}/applications/{deployedApplicationId}/acl/list

Parameters

Name Required Type Description
webhostId true string Web Host ID
deployedApplicationId true string Deployed Application ID

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified deployedApplication
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/authorities

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Deployed Application

Reads an instance of a Deployed Application
GET /webhosts/{webhostId}/applications/{deployedApplicationId}

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Deployed Application",
  "properties": {
    "applicationId": {
      "type": "string"
    },
    "deploymentKey": {
      "type": "string"
    },
    "deploymentWebhost": {
      "type": "string"
    },
    "host": {
      "type": "string"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Read the ACL for a principal

Reads the ACL for a deployed application and specific actor
GET /webhosts/{webhostId}/applications/{deployedApplicationId}/acl

Parameters

Name Required Type Description
webhostId true string Web Host ID
deployedApplicationId true string Deployed Application ID
id true string the Principal ID

, , Read the ACL for a principal , , ,

, Reads the ACL for a deployed application and specific actor ,,> , , Here are some NOTES ,

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Redeploy

POST /webhosts/{webhostId}/applications/{deployedApplicationId}/redeploy

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{}

Restart

POST /webhosts/{webhostId}/applications/{deployedApplicationId}/restart

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{}

Revoke Authority

Revokes an authority against the specified deployedApplication from a given user
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Start

POST /webhosts/{webhostId}/applications/{deployedApplicationId}/start

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{}

Starts an export job for this resource

Starts an export job for this resource
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/export

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /webhosts/{webhostId}/applications/{deployedApplicationId}/import

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Stop

POST /webhosts/{webhostId}/applications/{deployedApplicationId}/stop

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{}

Undeploy

POST /webhosts/{webhostId}/applications/{deployedApplicationId}/undeploy

Parameters

Name Required Type Description
webhostId true string
deployedApplicationId true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Deployed Application",
  "properties": {
    "applicationId": {
      "type": "string"
    },
    "deploymentKey": {
      "type": "string"
    },
    "deploymentWebhost": {
      "type": "string"
    },
    "host": {
      "type": "string"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  },
  "id": "deployedApplication"
}