Update Secret V2

Update Secret V2

Updates a secret

Request
URI
PATCH
https://vra-interop-222-139.lvn.broadcom.net/platform/api/secrets/{id}
COPY
Path Parameters
string
id
Required

the id of the secret

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format. For versioning information refer to /platform/api/about.

apiVersion example
2023-01-01
Request Body

Secret

SecretUpdateSpecification of type(s) application/json
Required

Show optional properties

{
    "name": "my-name",
    "value": "my-value"
}
{
    "name": "my-name",
    "description": "string",
    "value": "my-value",
    "orgScoped": false,
    "projectIdsToAdd": [
        "string"
    ],
    "projectIdsToRemove": [
        "string"
    ]
}
string
name
Required
Constraints: minLength: 0 maxLength: 255

A human-friendly name used as an identifier for a secret. Secret name should not contain special characters.

string
description
Optional

A human-friendly description.

string
value
Required
Constraints: minLength: 0 maxLength: 131072

The value of secret.

boolean
orgScoped
Optional

This boolean checks if the secret is org scope or project scope

array of string
projectIdsToAdd
Optional

A list of project IDs to add this secret to.

array of string
projectIdsToRemove
Optional

A list of project IDs to remove this secret from.

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the updated secret

Returns Secret of type(s) application/json 
"Secret Object"
string
orgId
Optional

The id of organization the secret belongs to. Can not be modified, only available in response.

string
projectId
Optional

The id of project the secret belongs to. Provided during create, can not be updated.

array of string
projectIds
Optional

IDs of projects, associated with the secret. This is not a full list and is limited to 10 projects.

string
projectName
Optional

The name of project the secret belongs to.

string
id
Optional

The unique identifier of a secret.

string
name
Required
Constraints: minLength: 0 maxLength: 255

A human-friendly name used as an identifier for a secret.

string
description
Optional

A human-friendly description.

string
value
Required
Constraints: minLength: 0 maxLength: 131072

The value of secret.

boolean
orgScoped
Optional

To check if the secret is a org scope or project scope

string
createdBy
Optional

The user that created this secret. Can not be modified. only available in response.

string
updatedBy
Optional

The user that last updated this secret. Can not be modified. only available in response.

string
createdAt
Optional

Date when the secret was created. The date is in ISO 8601 with time zone Can not be modified. only available in response.

string
updatedAt
Optional

Date when the secret was last updated. The date is in ISO 8601 with time zone. Can not be modified. only available in response.


401

Unauthorized, the user is not authenticated

Operation doesn't return any data structure

403

Forbidden, the user lacks permissions

Operation doesn't return any data structure

404

'Not found' if no secret with the provided id

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","value:"string"}'
On This Page
Secrets Operations
GET
Get All Secrets V2
POST
Create Secret V2
PATCH
Update Secret V2
GET
Get Projects Linked To Secret
GET
Get Projects