Get project-level ephemeral configuration for a provisioner

Returns whether ephemeral automation is currently enabled at the project level for the given provisioner, along with its raw schedule fields (ttl, destroy_on_date, delete_*) so the UI can re-render previously saved values.

get

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: i

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: keo

Query parameters

provisionerstring · enumRequired

Provisioner type to query ephemeral status for

Example: opentofuPossible values:

Header parameters

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

Account is the internal customer account ID.

Example: g7z

Responses

200

OK response.

application/json

delete_delay_unitstring · enumOptional

Configured delete delay unit (hours or days)

Example: secondsPossible values:

delete_delay_valueinteger · int64Optional

Configured delete delay value (when delete_workspace is true)

Example: 7865016720267615000

delete_on_datestringOptional

Configured delete date (YYYY-MM-DD) when schedule uses a specific date

Example: Sit fugiat et enim eligendi.

delete_workspacebooleanOptional

Whether workspace records will be deleted after destroy

Example: true

destroy_on_datestringOptional

Configured destroy date (YYYY-MM-DD) when schedule uses a specific date

Example: Omnis nihil beatae eligendi.

enabledbooleanRequired

Whether project-level ephemeral automation is currently enabled for this provisioner

Example: true

pipeline_idstringOptional

Pipeline configured for destroying infrastructure

Example: Est ea non sit.

provisionerstringRequired

Provisioner this configuration applies to

Example: Vero nisi eum facilis voluptas.

ttl_unitstring · enumOptional

Configured destroy delay unit (hours or days)

Example: daysPossible values:

ttl_valueinteger · int64Optional

Configured destroy delay value (when schedule uses delay)

Example: 8153434901632659000

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

get/api/orgs/{org}/projects/{project}/settings/ephemeral-config

GET /api/orgs/{org}/projects/{project}/settings/ephemeral-config?provisioner=opentofu HTTP/1.1
Host: localhost:80
Harness-Account: g7z
Accept: */*

{
  "delete_delay_unit": "hours",
  "delete_delay_value": 6383679355756895000,
  "delete_on_date": "Necessitatibus rem non ratione.",
  "delete_workspace": true,
  "destroy_on_date": "Dolor maxime aut quas.",
  "enabled": true,
  "pipeline_id": "Nostrum deleniti a labore qui reprehenderit vitae.",
  "provisioner": "Natus et quia quia dolorem qui rerum.",
  "ttl_unit": "seconds",
  "ttl_value": 8394293292974299000
}