Mission Control REST API v1

Overview

Mission Control exposes a rich REST API to allow fully automated management of Artifactory instances under your control.

Version

Deprecated

This version of Mission Control REST API has been deprecated. We strongly recommend updating your scripts to the latest version. For details, please refer toMission Control REST API.

Authentication

All Mission Control REST API endpoints require authentication using user/password.

Exception

TheSystem Health Checkendpoint does not require authentication.

Error Handling

Mission Control REST API returns error responses in different formats depending on where the error occurred.

Top Level Errors

Top level errors are returned if the request cannot be executed, and have the following format:

{ "errors" : [ { "message" : , // a descriptive error message string "type" :  // The error category } ] }

For example:

{ "errors": [ { "message": "selected script has wrong type: REPOSITORY", "type": "Template processing" } ] }

Page Contents

Instance Errors

Instance errors are returned for API endpoints that act on instances, such asCreate User,Create User GrouporUpdate Instanceand others.

{ "data": [ { "success": "false", // "false" indicates an error occurred "message": , // A descriptive error message string "instanceName":  // The instance on which the error occurred } ] }

For example:

{ "data": [ { "success": true, //The action on this instance succeeded "instanceName": "localhost:8091/artifactory" }, { "success": false, //The action on this instance failed "message": "Connection refused", "instanceName": "localhost:8081/artifactory" } ] }

Repository Errors

Repository errors are returned for API endpoints that act on repositories, such asUpdate Repositoryand others.

{ "data": [ { "success": "false", // "false" indicates an error occurred "message": , // A descriptive error message string "instanceName": , // The instance on which the error occurred "repositoryKey": "maven-local" // The repository on which the error occurred } ] }

For example:

{ "data": [ { "success": true, // This operation succeeded "instanceName": "localhost:8091/artifactory", "repositoryKey": "maven-local" }, { "success": false, // This operation failed "message": "Connection refused", "instanceName": "localhost:8081/artifactory", "repositoryKey": "maven-local" } ] }

Working with User Inputs

Mission control configuration scripts offer the flexibility of letting you provide input just before the script is applied. When working with the Mission Control UI, the User Input screen allows you to enter all user input values required for the scripts you are about to apply.

When working with the REST API, another mechanism is provided that allows you to fully automate your management of Artifactory instances usingScript Mappings.

For a detailsonhowtowork with script mappings and user input with the Mission Control REST API, please refer toWorking with User Input.

Mandatory Fields

For all endpoints, mandatory input fields are indicated by a plus sign (+).

REST Resources

The following sections provide a comprehensive list of2022世界杯阿根廷预选赛赛程exposed by the Mission Control REST API.

SCRIPT MAPPINGS

Get Script List

Description:Gets the list of instance and repository configuration scripts available on Mission Control
Since:1.0
Security:Requires an admin user
Usage:GET /api/v1/scripts
Consumes:None
Produces:application/json

{“数据”:[{“名称”:“字符串”,/ /脚本e "description" : "string", // The script description "target" : "INSTANCE" | "REPOSITORY" // Specifies whether this is an instance or repository scripts } ] }

Example:

GET /api/v1/scripts { "data": [ { "name" : "QA Property Sets", "description" : "Applies property sets used by QA", "target" : "INSTANCE" }, { "name" : "LDAP Dev", "description" : "Applies development group LDAP settings", "target" : "INSTANCE" }, ... { "name" : "Docker Local", "description" : "Creates a local Docker repo called docker-local", "target" : "REPOSITORY" }, { "name" : "Replicate releases-local", "description" : "Replicates releases-local repository to a target repo", "target" : "REPOSITORY" }, ] }

List User Inputs

Description:Gets the list of Artifactory user inputs needed for scripts that are being applied
Since:1.0
Security:Requires an admin user
Usage:POST /api/v1/userInputs
Consumes:application/json

{+”scriptMappings " : [ { // scriptMap数组ping objects + "instanceName" : , // The instance on which you want to apply a script "repositoryKey" : , // The repository on which you want to apply the script // Mandatory if the operationType is UPDATE_REPOSITORY. // *** Not applicable and should be omitted *** if the operationType is CREATE_REPOSITORY or UPDATE_INSTANCE "scriptNames" : [