Start activity

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

post

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: 5

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: lz8

workspacestring · min: 1 · max: 128Required

Workspace identifier

Example: yt9

Header parameters

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

Account is the internal customer account ID.

Example: o

Body

activity_idstring · uuidRequired

Client-generated UUID for idempotency

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

activity_typestring · enumRequired

Type of activity being performed

Example: driftPossible values:

pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Voluptatibus explicabo qui perspiciatis incidunt repudiandae.

pipeline_idstringOptional

Pipeline identifier

Example: Doloremque qui.

pipeline_stage_idstringOptional

Pipeline stage identifier

Example: Dignissimos ipsa odit temporibus aliquid voluptatibus illum.

provisioner_typestring · enumRequired

Type of provisioner

Example: tfPossible 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: Incidunt atque veritatis a totam quia illum.

started_atinteger · int64Required

Unix timestamp in milliseconds when activity started

Example: 1175301712301316900

statusstring · enumRequired

Current status of the activity

Example: startedPossible 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: o
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "activity_id": "550e8400-e29b-41d4-a716-446655440000",
  "activity_type": "destroy",
  "git_info": {
    "branch": "main",
    "commit_message": "Add new stack",
    "commit_sha": "abc123def456",
    "repo": "https://github.com/org/repo"
  },
  "pipeline_execution_id": "Ipsa placeat sit laudantium reiciendis velit.",
  "pipeline_id": "Rerum cum quae in sed quibusdam.",
  "pipeline_stage_id": "Ducimus aliquid veniam iure consequuntur repellat.",
  "provisioner_type": "awscdk",
  "provisioner_version": "2.100.0"
}

{
  "activity_id": "Iste quibusdam dicta nostrum.",
  "started_at": 3224387334349442000,
  "status": "failed"
}