PUT /orgs/{org}/actions/secrets/{secret_name}
Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
secret_name |
String | Yes |
The name of the secret. |
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
visibility |
String | Yes |
Which type of organization repositories have access to the organization secret. Possible values:
|
encrypted_value |
String | Yes |
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint. |
selected_repository_ids[] |
Array | No |
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the |
key_id |
String | Yes |
ID of the key you used to encrypt the secret. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.