operations

Get operation details

Returns the operation, answered by the resource that owns it. Visibility follows the owning resource. Clients poll this endpoint while done is false; when done flips true, response may carry the typed result (SUCCEEDED) and error.message carries a failure reason when available. Prefer POST /v1/operations/{id}:wait for sync “wait until done” semantics - it long-polls server-side instead of asking the client to tight-poll.

The owning resource answers directly, so the answer is never behind the Operation projection that GET /v1/operations reads. Terminal outcomes remain immutable.

GET

operations

{id}

Get operation details

curl --request GET \
  --url https://api.akua.dev/v1/operations/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.akua.dev/v1/operations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/operations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/operations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/operations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "organization_id": "<string>",
  "owner_type": "install",
  "owner_id": "<string>",
  "parent_operation_id": "<string>",
  "state": "RUNNING",
  "done": true,
  "html_url": "https://akua.dev/installs/inst_j572abc123def456?tab=operations",
  "metadata": {
    "type": "machine.create",
    "workspace_id": "<string>",
    "instance_type": "<string>",
    "managed": true,
    "request_fingerprint": "<string>",
    "cluster_id": "<string>",
    "compute_config_id": "<string>"
  },
  "response": {
    "type": "machine.create",
    "machine_id": "<string>",
    "provider_id": "<string>"
  },
  "error": {
    "message": "<string>",
    "code": 123,
    "reason": "billing-required"
  },
  "last_error": {
    "message": "<string>",
    "step_name": "<string>"
  },
  "started_at": 1,
  "completed_at": 1,
  "steps": [
    {
      "name": "<string>",
      "status": "pending",
      "execution_type": "system",
      "started_at": 1,
      "completed_at": 1,
      "error_message": "<string>",
      "retryable": true,
      "skippable": true
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}

Authorizations

Authorization

string

header

required

Bearer token for the authenticated caller.

Headers

akua-context

string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53

Example:

"ws_j572abc123def4"

Path Parameters

string

required

Required string length: 2 - 192

Response

Operation details

string

required

Required string length: 2 - 192

workspace_id

string | null

required

Required string length: 1 - 53

organization_id

string | null

required

Required string length: 1 - 54

owner_type

enum<string>

required

Domain entity collection the operation acts on.

Available options:

install,

repository_change_request,

repository,

workspace,

machine,

cluster,

node_pool,

package,

sandbox,

opencode

owner_id

string

required

Prefixed ID of the entity this operation acts on. Prefix matches owner_type (ws_, mch_, clu_, pkg_, inst_, rcr_, repo_, sbx_, oc_); a node pool is clu_<id>/node_pools/<node pool id>.

parent_operation_id

string | null

required

ID of the chained parent operation, when present.

Required string length: 2 - 192

state

enum<string>

required

Lifecycle state. Past-participle terminal states per AIP-216.

Available options:

RUNNING,

SUCCEEDED,

FAILED,

CANCELLED

done

boolean

required

True iff state is a terminal value.

html_url

string<uri>

required

Deep link to the dashboard view of this operation's owning resource when available, otherwise the operation detail page.

Maximum string length: 2048

Example:

"https://akua.dev/installs/inst_j572abc123def456?tab=operations"

metadata

object

required

Show child attributes

response

object

required

Populated only when done && state === "SUCCEEDED". Discriminated by type.

Show child attributes

error

object | null

required

Populated when state is FAILED or CANCELLED.

Show child attributes

last_error

object | null

required

Latest error from any failed step. Populated even mid-flight; cleared when the step succeeds on retry.

Show child attributes

started_at

integer

required

Unix timestamp (seconds)

Required range: x >= 0

completed_at

integer | null

required

Unix timestamp (seconds)

Required range: x >= 0

steps

object[]

Show child attributes

Get operation details

curl --request GET \
  --url https://api.akua.dev/v1/operations/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.akua.dev/v1/operations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.akua.dev/v1/operations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.akua.dev/v1/operations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/operations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "organization_id": "<string>",
  "owner_type": "install",
  "owner_id": "<string>",
  "parent_operation_id": "<string>",
  "state": "RUNNING",
  "done": true,
  "html_url": "https://akua.dev/installs/inst_j572abc123def456?tab=operations",
  "metadata": {
    "type": "machine.create",
    "workspace_id": "<string>",
    "instance_type": "<string>",
    "managed": true,
    "request_fingerprint": "<string>",
    "cluster_id": "<string>",
    "compute_config_id": "<string>"
  },
  "response": {
    "type": "machine.create",
    "machine_id": "<string>",
    "provider_id": "<string>"
  },
  "error": {
    "message": "<string>",
    "code": 123,
    "reason": "billing-required"
  },
  "last_error": {
    "message": "<string>",
    "step_name": "<string>"
  },
  "started_at": 1,
  "completed_at": 1,
  "steps": [
    {
      "name": "<string>",
      "status": "pending",
      "execution_type": "system",
      "started_at": 1,
      "completed_at": 1,
      "error_message": "<string>",
      "retryable": true,
      "skippable": true
    }
  ]
}

{
  "_tag": "Validation",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unauthorized",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Forbidden",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "NotFound",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Conflict",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Gone",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "TooManyRequests",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "InternalServerError",
  "success": false,
  "errors": [
    {
      "code": 7009,
      "message": "Internal server error"
    }
  ],
  "result": {}
}

{
  "_tag": "ExternalServiceError",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "ServiceUnavailable",
  "success": false,
  "errors": [],
  "result": {}
}

{
  "_tag": "GatewayTimeout",
  "success": false,
  "errors": [],
  "result": {}
}