Provisioner Activities

Provisioner Activities Service handles the API for managing provisioner activity lifecycle. This API provides explicit start and complete endpoints for provisioner operations (CDK, Terraform).

Complete activity

post

Complete a provisioner activity with results or error.

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: it

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 7

workspacestring · min: 1 · max: 128Required

Workspace identifier

Example: rl

activity_idstring · uuidRequired

The activity identifier from start-activity

Example: 9baba3a1-3261-4e1b-835a-7d50c2c6282b

Header parameters

Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 4l

Body

error_messagestringOptional

Error message if status is failed

Example: Vel est sint consequuntur.

statusstring · enumRequired

Final status of the activity

Example: failedPossible values:

Responses

200

OK response.

application/json

activity_idstringRequired

The activity identifier

Example: Tenetur sint.

completed_atinteger · int64Required

Unix timestamp in milliseconds when activity completed

Example: 1905400213695812000

statusstring · enumRequired

Final status of the activity

Example: failedPossible values:

workspace_statusstring · enumOptional

Updated workspace status after activity completion

Example: failedPossible values:

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/{activity_id}/complete

POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/{activity_id}/complete HTTP/1.1
Host: localhost:80
Harness-Account: 4l
Content-Type: application/json
Accept: */*
Content-Length: 3180

{
  "cdk_result": {
    "stacks": [
      {
        "assets_uuid": "Iusto ipsa atque quis harum aut reiciendis.",
        "drift_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "drift_uuid": "Velit eaque non rerum provident laborum alias.",
        "error_message": "Voluptatem dolorem.",
        "manifest_uuid": "Voluptatem vel.",
        "resource_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "stack_name": "NetworkingStack",
        "stack_outputs": {
          "Atque id cumque.": "Incidunt quis qui perferendis voluptatem est quasi.",
          "Natus dignissimos repellat tempora sit id illum.": "Sunt doloribus praesentium fugit.",
          "Repellat qui molestiae autem voluptatum et quos.": "Necessitatibus est aperiam sed quia."
        },
        "stack_path": "stacks/networking",
        "status": "drifted",
        "template_uuid": "Incidunt in doloremque quos.",
        "tree_uuid": "Doloribus earum maxime."
      },
      {
        "assets_uuid": "Iusto ipsa atque quis harum aut reiciendis.",
        "drift_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "drift_uuid": "Velit eaque non rerum provident laborum alias.",
        "error_message": "Voluptatem dolorem.",
        "manifest_uuid": "Voluptatem vel.",
        "resource_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "stack_name": "NetworkingStack",
        "stack_outputs": {
          "Atque id cumque.": "Incidunt quis qui perferendis voluptatem est quasi.",
          "Natus dignissimos repellat tempora sit id illum.": "Sunt doloribus praesentium fugit.",
          "Repellat qui molestiae autem voluptatum et quos.": "Necessitatibus est aperiam sed quia."
        },
        "stack_path": "stacks/networking",
        "status": "drifted",
        "template_uuid": "Incidunt in doloremque quos.",
        "tree_uuid": "Doloribus earum maxime."
      },
      {
        "assets_uuid": "Iusto ipsa atque quis harum aut reiciendis.",
        "drift_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "drift_uuid": "Velit eaque non rerum provident laborum alias.",
        "error_message": "Voluptatem dolorem.",
        "manifest_uuid": "Voluptatem vel.",
        "resource_counts": {
          "added": 2737275095070377000,
          "changed": 3189160904069314600,
          "deleted": 4609501253999804000,
          "imported": 8048488091296873000,
          "removed": 591961175117043600,
          "unchanged": 6176175569340644000
        },
        "stack_name": "NetworkingStack",
        "stack_outputs": {
          "Atque id cumque.": "Incidunt quis qui perferendis voluptatem est quasi.",
          "Natus dignissimos repellat tempora sit id illum.": "Sunt doloribus praesentium fugit.",
          "Repellat qui molestiae autem voluptatum et quos.": "Necessitatibus est aperiam sed quia."
        },
        "stack_path": "stacks/networking",
        "status": "drifted",
        "template_uuid": "Incidunt in doloremque quos.",
        "tree_uuid": "Doloribus earum maxime."
      }
    ]
  },
  "error_message": "Eligendi sint exercitationem.",
  "status": "failed"
}

{
  "activity_id": "Deleniti repellat.",
  "completed_at": 6866096195013383000,
  "status": "completed",
  "workspace_status": "drifted"
}

Start activity

post

Start a new provisioner activity. The activity_id is client-generated for idempotency.

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: d

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: p

workspacestring · min: 1 · max: 128Required

Workspace identifier

Example: mkh

Header parameters

Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 3

Body

activity_idstring · uuidRequired

Client-generated UUID for idempotency

Example: 550e8400-e29b-41d4-a716-446655440000

activity_typestring · enumRequired

Type of activity being performed

Example: destroyPossible values:

pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Debitis et hic.

pipeline_idstringOptional

Pipeline identifier

Example: Itaque sequi et repudiandae.

pipeline_stage_idstringOptional

Pipeline stage identifier

Example: Recusandae enim officia nemo.

provisioner_typestring · enumRequired

Type of provisioner

Example: awscdkPossible values:

provisioner_versionstringOptional

Version of the provisioner (CDK CLI version, Terraform version)

Example: 2.100.0

Responses

200

OK response.

application/json

activity_idstringRequired

The activity identifier

Example: Repellat et quae est accusantium et.

started_atinteger · int64Required

Unix timestamp in milliseconds when activity started

Example: 2282959230457609000

statusstring · enumRequired

Current status of the activity

Example: completedPossible values:

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/start

POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/provisioner-activities/start HTTP/1.1
Host: localhost:80
Harness-Account: 3
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "activity_id": "550e8400-e29b-41d4-a716-446655440000",
  "activity_type": "drift",
  "git_info": {
    "branch": "main",
    "commit_message": "Add new stack",
    "commit_sha": "abc123def456",
    "repo": "https://github.com/org/repo"
  },
  "pipeline_execution_id": "Cupiditate atque quod nam consequatur.",
  "pipeline_id": "Doloremque modi.",
  "pipeline_stage_id": "Repellendus cupiditate enim quia.",
  "provisioner_type": "awscdk",
  "provisioner_version": "2.100.0"
}

{
  "activity_id": "Officiis maiores dolore sed pariatur sapiente.",
  "started_at": 6643967846956598000,
  "status": "completed"
}