PATCH /orgs/{org}/private-registries/{secret_name}
[!NOTE] This endpoint is in public preview and is subject to change.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."
OAuth app tokens and personal access tokens (classic) need the admin:org 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 | No |
Which type of organization repositories have access to the private registry. Possible values:
|
username |
String | No |
The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. |
encrypted_value |
String | No |
The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. |
selected_repository_ids[] |
Array | No |
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when |
registry_type |
String | No |
The registry type. Possible values:
|
key_id |
String | No |
The 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.