Summary
Update repository configuration
Description
Update an existing repository configuration
Route
PATCH /prebuilts-repository/configs/:name
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
The name of the repository configuration |
| updates |
object |
yes |
The properties to update in the repository configuration |
Copied to Clipboard
{
"updates": {
"enabled": false,
"type": "gitlab",
"hostname": "gitlab.com",
"path": "itentialopensource/pre-built-automations",
"credentials": {
"token": "uTc_P4pnMAEsLbQHmyOt"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"updates": {
"title": "updates",
"properties": {
"enabled": {
"type": "boolean",
"description": "A flag that denotes if the repository configuration is connected"
},
"type": {
"type": "string",
"description": "The type of Repository",
"enum": [
"gitlab"
]
},
"hostname": {
"type": "string",
"description": "The hostname of the Respository endpoint",
"examples": [
"gitlab.com"
]
},
"path": {
"type": "string",
"description": "The path of the Repository endpoint",
"examples": [
"itentialopensource/pre-built-automations"
]
},
"credentials": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "An access token used to make HTTP requests",
"examples": [
"uTc_P4pnMAEsLbQHmyOt"
]
}
},
"additionalProperties": false
}
}
}
},
"required": [
"updates"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
The result of the update process |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"data": {
"enabled": false,
"type": "gitlab",
"hostname": "gitlab.com",
"path": "itentialopensource/pre-built-automations",
"credentials": {
"token": "uTc_P4pnMAEsLbQHmyOt"
},
"versionStatus": "latest"
}
}
