Summary
Get all installed artifacts
Description
Gets all the currently installed artifacts.
Route
GET /admin/artifacts
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"limit": 50,
"skip": 50,
"order": 1,
"sort": "name",
"equals": {
"name": "device-connection-health-check",
"version": "1.1.1-2020.1.0",
"keywords": [
"Itential",
"Itential",
"Itential"
]
},
"contains": {
"name": "artifact-wizard",
"description": "Description about the functionality of an artifact"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Number of results to return. Used for pagination.",
"default": 25,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"skip": {
"type": "integer",
"description": "Number of results to skip. Used for pagination.",
"default": 0,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"order": {
"type": "integer",
"description": "The sort direction: 1 for ascending or -1 for descending.",
"default": 1,
"enum": [
-1,
1
]
},
"sort": {
"type": "string",
"description": "Field to sort by. Default is name.",
"default": "name",
"enum": [
"name"
]
},
"equals": {
"type": "object",
"additionalProperties": false,
"description": "Searches the list of artifacts for exact matches to the provided query.",
"properties": {
"name": {
"$ref": "commonProperties#/definitions/name"
},
"version": {
"$ref": "commonProperties#/definitions/version"
},
"keywords": {
"$ref": "commonProperties#/definitions/keywords"
}
}
},
"contains": {
"type": "object",
"description": "Searches the list of artifacts for inclusive matches to the provided query.",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "commonProperties#/definitions/name"
},
"description": {
"$ref": "commonProperties#/definitions/description"
}
}
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
Artifacts |
object |
Available artifacts from the database. |
Copied to Clipboard
{
"Artifacts": true
}
Copied to Clipboard
{
"title": "Artifacts",
"type": "object",
"required": [
"packages",
"total"
],
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "artifactDB-schema"
}
},
"total": {
"$id": "#/properties/total",
"type": "integer"
}
}
}