Update a workspace secret

Update a secret

curl --request PATCH \
  --url https://api.onecli.sh/v1/secrets/{secretId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "value": "<string>",
  "opRef": "<string>",
  "opDisplay": {
    "vault": "<string>",
    "item": "<string>",
    "field": "<string>"
  },
  "hostPattern": "<string>",
  "pathPattern": "<string>",
  "injectionConfig": {
    "headerName": "<string>",
    "valueFormat": "<string>"
  }
}
'

import requests

url = "https://api.onecli.sh/v1/secrets/{secretId}"

payload = {
    "name": "<string>",
    "value": "<string>",
    "opRef": "<string>",
    "opDisplay": {
        "vault": "<string>",
        "item": "<string>",
        "field": "<string>"
    },
    "hostPattern": "<string>",
    "pathPattern": "<string>",
    "injectionConfig": {
        "headerName": "<string>",
        "valueFormat": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    value: '<string>',
    opRef: '<string>',
    opDisplay: {vault: '<string>', item: '<string>', field: '<string>'},
    hostPattern: '<string>',
    pathPattern: '<string>',
    injectionConfig: {headerName: '<string>', valueFormat: '<string>'}
  })
};

fetch('https://api.onecli.sh/v1/secrets/{secretId}', 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.onecli.sh/v1/secrets/{secretId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'value' => '<string>',
    'opRef' => '<string>',
    'opDisplay' => [
        'vault' => '<string>',
        'item' => '<string>',
        'field' => '<string>'
    ],
    'hostPattern' => '<string>',
    'pathPattern' => '<string>',
    'injectionConfig' => [
        'headerName' => '<string>',
        'valueFormat' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.onecli.sh/v1/secrets/{secretId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onecli.sh/v1/secrets/{secretId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/secrets/{secretId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}"

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

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PATCH

secrets

{secretId}

Update a secret

curl --request PATCH \
  --url https://api.onecli.sh/v1/secrets/{secretId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "value": "<string>",
  "opRef": "<string>",
  "opDisplay": {
    "vault": "<string>",
    "item": "<string>",
    "field": "<string>"
  },
  "hostPattern": "<string>",
  "pathPattern": "<string>",
  "injectionConfig": {
    "headerName": "<string>",
    "valueFormat": "<string>"
  }
}
'

import requests

url = "https://api.onecli.sh/v1/secrets/{secretId}"

payload = {
    "name": "<string>",
    "value": "<string>",
    "opRef": "<string>",
    "opDisplay": {
        "vault": "<string>",
        "item": "<string>",
        "field": "<string>"
    },
    "hostPattern": "<string>",
    "pathPattern": "<string>",
    "injectionConfig": {
        "headerName": "<string>",
        "valueFormat": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    value: '<string>',
    opRef: '<string>',
    opDisplay: {vault: '<string>', item: '<string>', field: '<string>'},
    hostPattern: '<string>',
    pathPattern: '<string>',
    injectionConfig: {headerName: '<string>', valueFormat: '<string>'}
  })
};

fetch('https://api.onecli.sh/v1/secrets/{secretId}', 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.onecli.sh/v1/secrets/{secretId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'value' => '<string>',
    'opRef' => '<string>',
    'opDisplay' => [
        'vault' => '<string>',
        'item' => '<string>',
        'field' => '<string>'
    ],
    'hostPattern' => '<string>',
    'pathPattern' => '<string>',
    'injectionConfig' => [
        'headerName' => '<string>',
        'valueFormat' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.onecli.sh/v1/secrets/{secretId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onecli.sh/v1/secrets/{secretId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/secrets/{secretId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"value\": \"<string>\",\n  \"opRef\": \"<string>\",\n  \"opDisplay\": {\n    \"vault\": \"<string>\",\n    \"item\": \"<string>\",\n    \"field\": \"<string>\"\n  },\n  \"hostPattern\": \"<string>\",\n  \"pathPattern\": \"<string>\",\n  \"injectionConfig\": {\n    \"headerName\": \"<string>\",\n    \"valueFormat\": \"<string>\"\n  }\n}"

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

{
  "success": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Edits a workspace secret in place, for example to rotate a key. Organization secrets are updated through Organization secrets instead. See How it works. Updates one or more fields on a workspace secret. At least one field must be provided. Organization secrets are updated through PATCH /org/secrets/{secretId}.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

secretId

string

required

Body

application/json

At least one field must be provided. Set valueSource to onepassword (with opRef) to switch to a 1Password-resolved value, or provide value to store an inline value.

name

string

Required string length: 1 - 255

valueSource

enum<string>

Available options:

inline,

onepassword

value

string

Required string length: 1 - 10000

opRef

string

opDisplay

object

Show child attributes

hostPattern

string

pathPattern

string | null

Maximum string length: 1000

injectionConfig

Header injection · object

How the gateway injects this secret into matching outbound requests (generic secrets only). Exactly one variant:

Header — { "headerName": "Authorization", "valueFormat": "Bearer {value}" }
Query parameter — { "paramName": "key", "paramFormat": "{value}" }
URL path template — { "pathTemplate": "/bot{value}" } (must start with / and contain {value} exactly once)
URL path regex — { "pathRegex": "^/bot([^/]+)", "pathReplacement": "/bot{value}" } (replacement must contain {value})

Unknown or mixed keys are rejected.

Header injection
Query parameter injection
URL path template injection
URL path regex injection

Show child attributes

Response

Updated

success

boolean