Get deployment artifact packages

Fetches a list of deployment packages that are yet to be deployed.

GET <base-address>/api/extensibility/v1/deployment/packages

{
  "Success": true,
  "Data": [
    {
      "PackageName": "repositoryname__branchname__2",
      "ImportedOn": "2023-08-04T01:51:42"
    },
    {
      "PackageName": "repositoryname__branchname__1",
      "ImportedOn": "2023-08-02T13:33:02"
    }
  ],
  "StatusCode": "OK"
}

Deploy package

Deploys the package asynchronously. Package may contain CustomCode, Configuration, and Schema.

GET <base-address>/api/extensibility/v1/deployment/package/deploy

Sample build artifact package name: democustomer-pipeline-test__master__1

Sample Payload:

{
    "PackageName": "democustomer-pipeline-test__master__1"
}

Sample Response

{
    "Success": true,
    "Data": {
        "PackageName": "democustomer-pipeline-test__master__1",
        "DeploymentId": "f7994a15-df7f-41d6-aef8-9977c2fddd35"
    },
    "StatusCode": "Created"
}

Track package deployment status

Gets the status of the package and any available resource for the given deployment ID.

GET <base-address>/api/extensibility/v1/deployment/{deploymentId}/status

{
  "Success": true,
  "Data": {
    "Name": "package-name",
    "Status": "Inprogress",
    "DeploymentId": "deployment-id",
    "ProjectStatus": [
      {
        "ResourceName": "custom-code-1",
        "ResourceType": null,
        "Status": "Inprogress"
      }
       {
        "ResourceName": "custom-code-2",
        "ResourceType": null,
        "Status": "Inprogress"
      }      ]
  },
  "StatusCode": "OK"
}

Get package deployment log

Retrieves the package deployment logs for the given deployment ID.

GET <base-address>/api/extensibility/v1/deployment/{deploymentId}/logs

Fetch log data

Retrieves the worker logs for the given deployment ID.

POST <base-address>/api/telemetry/v1/logs/start-time/{startTime}/end-time/{endTime}

{
  "CustomCodeDeploymentId": "f7994a15-df7f-41d6-aef8-9977c2fddd35",
}