Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

credentials

Update the specified topic

You need workspaces.credential.edit permission to access this resource

patch/credentials/{credential_id}

Path parameters

credential_idstring required

Credential identifier

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "attributes": {
      "name": "Credential name"
    },
    "relationships": {
      "vpn_agent": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/vpn_agents/5b4f337bff4304610483ba67"
        }
      }
    }
  }
}

Response

OK

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/credentials/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Credential name"
    },
    "relationships": {
      "component": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/components/5b4f337bff4304610483ba67"
        }
      },
      "workspace": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67"
        }
      },
      "vpn_agent": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/vpn_agents/5b4f337bff4304610483ba67"
        }
      },
      "user": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/users/5b4f337bff4304610483ba67"
        }
      }
    }
  }
}