Disable a version - Akua

POST

vaults

{vault}

secrets

{secret}

versions

{version}

:disable

Disable a version

curl --request POST \
  --url https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable \
  --header 'Authorization: Bearer <token>' \
  --header 'if-match: <if-match>'

import requests

url = "https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable"

headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'if-match': '<if-match>', Authorization: 'Bearer <token>'}
};

fetch('https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable', 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/vaults/{vault}/secrets/{secret}/versions/{version}:disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "if-match: <if-match>"
  ],
]);

$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/vaults/{vault}/secrets/{secret}/versions/{version}:disable"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable")

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

request = Net::HTTP::Post.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "<string>",
  "version": 123,
  "state": "ENABLED",
  "created_at": 1,
  "destroyed_at": 1,
  "etag": "<string>"
}

{
  "_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": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

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

{
  "_tag": "ServiceUnavailable",
  "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"

idempotency-key

string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64

Example:

"create-prod-2026-05-07"

if-match

string

required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256

Example:

"42"

Path Parameters

vault

string

required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Example:

"default"

secret

string

required

A secret id, unique in its vault

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Example:

"db-password"

version

string

required

A version number or latest

Pattern: ^(latest|[1-9][0-9]{0,8})$

Examples:

"latest"

"3"

Response

SecretVersion

name

string

required

Resource name vaults/{vault}/secrets/{secret}/versions/{version}.

version

integer

required

state

enum<string>

required

Available options:

ENABLED,

DISABLED,

DESTROYED

created_at

integer

required

Unix timestamp (seconds)

Required range: x >= 0

destroyed_at

integer | null

required

Unix timestamp (seconds)

Required range: x >= 0

etag

string

required

Pass as If-Match on writes. OUTPUT_ONLY.

Maximum string length: 64

Disable a version

curl --request POST \
  --url https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable \
  --header 'Authorization: Bearer <token>' \
  --header 'if-match: <if-match>'

import requests

url = "https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable"

headers = {
    "if-match": "<if-match>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'if-match': '<if-match>', Authorization: 'Bearer <token>'}
};

fetch('https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable', 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/vaults/{vault}/secrets/{secret}/versions/{version}:disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "if-match: <if-match>"
  ],
]);

$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/vaults/{vault}/secrets/{secret}/versions/{version}:disable"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable")
  .header("if-match", "<if-match>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.akua.dev/v1/vaults/{vault}/secrets/{secret}/versions/{version}:disable")

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

request = Net::HTTP::Post.new(url)
request["if-match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "<string>",
  "version": 123,
  "state": "ENABLED",
  "created_at": 1,
  "destroyed_at": 1,
  "etag": "<string>"
}

{
  "_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": "Unprocessable",
  "success": false,
  "errors": [],
  "result": {}
}

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

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