Summary
Get Repository Configurations
Description
Get all the Prebuilt Repository configurations
Route
GET /prebuilts-repository/configs
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "redis",
"containsField": "name",
"equals": "redis",
"equalsField": "name",
"startsWith": "redis",
"startsWithField": "name",
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"redis"
]
},
"containsField": {
"type": "string",
"examples": [
"name"
]
},
"equals": {
"type": "string",
"examples": [
"redis"
]
},
"equalsField": {
"type": "string",
"examples": [
"name"
]
},
"startsWith": {
"type": "string",
"examples": [
"redis"
]
},
"startsWithField": {
"type": "string",
"examples": [
"name"
]
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
Contains an array of prebuilts and the total in the response. |
Copied to Clipboard
{
"results": [
{
"name": "@itentialopensource/aggregate-functions-for-arrays",
"enabled": true,
"type": "gitlab",
"hostname": "gitlab.com",
"path": "itentialopensource/pre-built-automations",
"credentials": {
"token": "uTc_P4pnMAEsLbQHmyOt"
}
},
{
"name": "@itentialopensource/cisco-nx-upgrade",
"enabled": true,
"type": "gitlab",
"hostname": "gitlab.com",
"path": "itentialopensource/pre-built-automations",
"credentials": {
"token": "uTc_P4pnMAEsLbQHmyOt"
}
}
],
"total": 5
}
Copied to Clipboard
{
"title": "results",
"type": "object",
"required": [
"results",
"total"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "prebuilts-schema#/properties/metadata/properties/name"
},
"enabled": {
"$ref": "repository-schema#/properties/enabled"
},
"type": {
"$ref": "repository-schema#/properties/type"
},
"hostname": {
"$ref": "repository-schema#/properties/hostname"
},
"path": {
"$ref": "repository-schema#/properties/path"
},
"credentials": {
"$ref": "repository-schema#/properties/credentials"
}
}
}
},
"total": {
"$ref": "common-schema#/definitions/total"
}
}
}
