Class DeploymentsService

APIs related to integrating deployments data with Jira Software. These APIs are available to Atlassian Connect apps. To use these APIs you must have the Deployment module see https://developer.atlassian.com/cloud/jira/software/modules/deployment/ in your app's descriptor. They are also related to integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials, see https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-deployments

Hierarchy

  • CommonHttpService
    • DeploymentsService

Constructors

constructor

Methods

deleteDeploymentByKey deleteDeploymentsByProperty getDeploymentByKey getDeploymentGatingStatusByKey submitDeployments initialize

Constructors

constructor

  • new DeploymentsService(getClientInstance): DeploymentsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns DeploymentsService

Methods

deleteDeploymentByKey

  • deleteDeploymentByKey(params): Promise<void>

  • Delete the currently stored deployment data for the given pipelineId, environmentId and deploymentSequenceNumber combination.

    Deletion is performed asynchronously. The getDeploymentByKey operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraDeploymentInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          deploymentSequenceNumber: number;
          environmentId: string;
          pipelineId: string;
          updateSequenceNumber?: number;
      }
      • authorization: string

        All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.

        If the Connect JWT token corresponds to an app that does not define jiraDeploymentInfoProvider module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

      • deploymentSequenceNumber: number

        The deployment's deploymentSequenceNumber.

      • environmentId: string

        The ID of the deployment's environment.

      • pipelineId: string

        The ID of the deployment's pipeline.

      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional _updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-deployments#api-rest-deployments-0-1-pipelines-pipelineid-environments-environmentid-deployments-deploymentsequencenumber-delete

deleteDeploymentsByProperty

  • deleteDeploymentsByProperty(params): Promise<void>

  • Bulk delete all deployments that match the given request.

    One or more query params must be supplied to specify the Properties to delete by. Optional param _updateSequenceNumber is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (i.e. treated as AND). See the documentation for the submitDeployments operation for more details.

    Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

    Deletion is performed asynchronously. The getDeploymentByKey operation can be used to confirm that data has been deleted successfully (if needed).

    Only Connect apps that define the jiraDeploymentInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'DELETE' scope for Connect apps.

    Parameters

    • params: {
          authorization: string;
          updateSequenceNumber?: number;
      }
      • authorization: string

        All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.

        If the Connect JWT token corresponds to an app that does not define jiraDeploymentInfoProvider module it will be rejected with a 403.

        See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

      • OptionalupdateSequenceNumber?: number

        This parameter usage is no longer supported.

        An optional updateSequenceNumber to use to control deletion.

        Only stored data with an updateSequenceNumber less than or equal to that provided will be deleted. This can be used help ensure submit/delete requests are applied correctly if issued close together.

        If not provided, all stored data that matches the request will be deleted.

        Deprecated

    Returns Promise<void>

    Path

    DELETE /rest/deployments/0.1/bulkByProperties

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-deployments#api-rest-deployments-0-1-bulkbyproperties-delete

getDeploymentByKey

getDeploymentGatingStatusByKey

submitDeployments

  • submitDeployments(params): Promise<SubmitDeploymentsResponse>

  • Update / insert deployment data.

    Deployments are identified by the combination of pipelineId, environmentId and deploymentSequenceNumber, and existing deployment data for the same deployment will be replaced if it exists and the updateSequenceNumber of existing data is less than the incoming data.

    Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getDeploymentByKey operation can be used to confirm that data has been stored successfully (if needed).

    In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object.

    Only Connect apps that define the jiraDeploymentInfoProvider module, and on-premise integrations, can access this resource. This resource requires the 'WRITE' scope for Connect apps.

    Parameters

    Returns Promise<SubmitDeploymentsResponse>

    Submission accepted. Each submitted deployment that is of a valid format will eventually be available in Jira.

    Details of which deployments were submitted and which failed submission (due to data format problems etc.) are available in the response object.

    Path

    POST /rest/deployments/0.1/bulk

    See

    https://developer.atlassian.com/cloud/jira/software/rest/api-group-deployments#api-rest-deployments-0-1-bulk-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods