Update agent provider

PUT/workspaces/{organizationId}/agent/providers/{agentId}

Path parameters

organizationIdstringrequired

agentIdstringrequired

Request body

application/json

modestring

Allowed:hostedbyo

tokenstring | null

providerOrgIdstring | null

outpoststring | null

outpostIdstring | null

outpostTokenstring | null

computeApiKeystring | null

computeApiUrlstring | null

computeSnapshotstring | null

computeVolumeIdstring | null

configobject | null

teamIdsstring[] | null

Responses

200Provider config saved (secrets redacted)

agentIdstringrequired

hasTokenbooleanrequired

providerOrgIdstring | nullrequired

outpoststring | nullrequired

hasOutpostTokenbooleanrequired

hasComputeApiKeybooleanrequired

computeApiUrlstring | nullrequired

computeSnapshotstring | nullrequired

computeVolumeIdstring | nullrequired

configobject | nullrequired

teamIdsstring[] | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*agentIdpath*

Bodyapplication/json

Request body

Request

curl -X PUT "/workspaces/string/agent/providers/string" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "hosted",
  "token": "string",
  "providerOrgId": "string",
  "outpost": "string",
  "outpostId": "string",
  "outpostToken": "string",
  "computeApiKey": "string",
  "computeApiUrl": "string",
  "computeSnapshot": "string",
  "computeVolumeId": "string",
  "config": {
    "property1": null,
    "property2": null
  },
  "teamIds": [
    "string"
  ]
}'

const response = await fetch("/workspaces/string/agent/providers/string", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"mode\": \"hosted\",\n  \"token\": \"string\",\n  \"providerOrgId\": \"string\",\n  \"outpost\": \"string\",\n  \"outpostId\": \"string\",\n  \"outpostToken\": \"string\",\n  \"computeApiKey\": \"string\",\n  \"computeApiUrl\": \"string\",\n  \"computeSnapshot\": \"string\",\n  \"computeVolumeId\": \"string\",\n  \"config\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"teamIds\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.put(
    "/workspaces/string/agent/providers/string",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"mode\": \"hosted\",\n  \"token\": \"string\",\n  \"providerOrgId\": \"string\",\n  \"outpost\": \"string\",\n  \"outpostId\": \"string\",\n  \"outpostToken\": \"string\",\n  \"computeApiKey\": \"string\",\n  \"computeApiUrl\": \"string\",\n  \"computeSnapshot\": \"string\",\n  \"computeVolumeId\": \"string\",\n  \"config\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"teamIds\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "agentId": "string",
  "hasToken": true,
  "providerOrgId": "string",
  "outpost": "string",
  "hasOutpostToken": true,
  "hasComputeApiKey": true,
  "computeApiUrl": "string",
  "computeSnapshot": "string",
  "computeVolumeId": "string",
  "config": {
    "property1": null,
    "property2": null
  },
  "teamIds": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string"
}