Update service

Update a service in an Agent Vault access bundle

PATCH /api/v1/agent-vault/access-bundles/{accessBundleId}/services/{serviceId}

cURL

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v1/agent-vault/access-bundles/{accessBundleId}/services/{serviceId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "hostPattern": "<string>",
  "allowedMethods": [],
  "allowedPathPrefixes": [
    "<string>"
  ],
  "credential": {
    "type": "bearer",
    "headerName": "<string>",
    "headerPrefix": "<string>",
    "value": "<string>"
  },
  "customHeaders": [
    {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prefix": "<string>",
      "value": "<string>"
    }
  ],
  "substitutions": [
    {
      "placeholder": "<string>",
      "surfaces": [],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ]
}
'

200

{
  "service": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "accessBundleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "hostPattern": "<string>",
    "allowedMethods": [
      "GET"
    ],
    "allowedPathPrefixes": [
      "<string>"
    ],
    "credential": {
      "type": "bearer",
      "headerName": "<string>",
      "headerPrefix": "<string>"
    },
    "customHeaders": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "prefix": "<string>"
      }
    ],
    "substitutions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "placeholder": "<string>",
        "surfaces": [
          "path"
        ]
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

accessBundleId · string<uuid> · required

The ID of the access bundle.

serviceId · string<uuid> · required

The ID of the service.

Body

application/json

name · string

The name of the service.

Required string length: 1 - 64

hostPattern · string

A comma-separated set of hosts this service covers, each optionally with a port (defaults to 443). A leading *. wildcard matches exactly one label. Paths are not supported.

Maximum string length: 1024

allowedMethods · enum<string>[] | null

The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403.

Required array length: 1 - 7 elements

Available options: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS

allowedPathPrefixes · string[] | null

The path prefixes this service allows, matched on whole segments, so /repos covers /repos/octo but not /repositories. null allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge.

Required array length: 1 - 20 elements

credential · Bearer · object

Bearer

Basic Auth

Pass-through

Show child attributes

customHeaders · object[]

Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's id to change it in place and keep its stored value. Without an id, a header is matched by name.

Maximum array length: 20

Show child attributes

substitutions · object[]

Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's id to change it in place and keep its stored value. Without an id, it is matched by its placeholder.

Maximum array length: 20

Show child attributes

Response

200

application/json

Default Response

service · object · required

Show child attributes