Follow the recreate of an environment workload

GET

/api/apps/{id}/environments/{envId}/workload-tasks/{taskId}

const url = 'https://opfield.example.com/api/apps/550e8400-e29b-41d4-a716-446655440000/environments/550e8400-e29b-41d4-a716-446655440000/workload-tasks/550e8400-e29b-41d4-a716-446655440000';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://opfield.example.com/api/apps/550e8400-e29b-41d4-a716-446655440000/environments/550e8400-e29b-41d4-a716-446655440000/workload-tasks/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Authorization: Bearer <token>'

A Docker task of a container of the environment, such as the recreate a client starts to apply pendingWorkloads (the container recreate answers its taskId): {id, type, status: pending|running|succeeded|failed, progress, error, completedAt}. The recreate has finished only when status is succeeded; failed carries the error. Needs apps:env:manage on the environment, not docker:tasks. 404 for a task of anything else.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

envId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

taskId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful response

application/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}