Mission Control REST API v2

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

{
  "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"
    }
  ]
}

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

{
  "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"
    }
  ]
}

PUT /api/v2/security/permission_targets/{permission_target_name}
{
	"instancesIds":["art1","art2"],
	...
	"failurePolicy" : "rollback" | "retry" | "fail" | "ignore" 
}

{
	"data": [	
	{
		"name" : "string",						// The script name
		"description" : "string",				// The script description
		"target" : "INSTANCE" | "REPOSITORY"  	// Specifies whether this is an instance or repository scripts
	}
	]
}

GET /api/v2/scripts
{
	"data": [
	{
		"name": "local-default",
		"target": "REPOSITORY"
	},
	{
		"name": "remote-default",
		"target": "REPOSITORY"
	},
	{
		"name": "propertySet_prodready",
		"target": "INSTANCE"
	}
	]
}

{
+	"scriptMappings" : [ {    //An array of scriptMapping objects 
+		"instanceName" : <instance name>,			// The instance on which you want to apply a script
        "repositoryKey" : <string>, // 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" : [<script name>, <script name>, ...]	 //The names of the scripts you want to apply		
		}	
	]
	"operationType":	 "CREATE_REPOSITORY" | "UPDATE_REPOSITORY" | "UPDATE_INSTANCE" //The type of operation you want to perform in the subsequent call with the user inputs returned
}

{
	"data": 
		[ 
			{ 
				"success" : true, 
				"instanceName" : "localhost:8091/artifactory", 
				"repositoryKey" : "maven-local", 	// The repository on which the script was applied
				                                    // Only present if operationType was UPDATE_REPOSITORY.
				"scriptUserInputs" : [
					{
						"multiple" : "boolean",	// Whether this user input item can take multiple values
						"type" : "STRING" | "BOOLEAN" | "INTEGER" | "INSTANCE" | "REPOSITORY", // The type of this user input item
						"value" : "object",		// A default value for this user input item
						"description" : "string", // A description for this user input item
						"name" : "string",		// A logical name for this user input item
						"id" : "string"		// The identifier of this user input item. This is the identifier that must be used in any subsequent API call
					} ]		
 			}
		]
}

POST /api/v2/scripts/user_inputs
{
	"scriptMappings": [{
		"instanceName": "Master",
		"scriptNames": ["local-string-userInput", "local-instance-userInput", "local-repo-userInput"]
	}],
	"operationType" : "CREATE_REPOSITORY"
}
 
Response:
{
	"data": [
	{
		"success": true,
		"instanceName": "Master",
		"scriptUserInputs": [
		{
			"id": "RepositoryMapper#0#description#0",
			"name": "User Friendly Name",
			"description": "please provide a value",
			"value": "default value",
			"type": "STRING",
			"multiple": false
		},
		{
			"id": "TemplateExecutor#0#test#0",
			"name": "test",
			"type": "INSTANCE",
			"multiple": false
		},
		{
			"id": "TemplateExecutor#0#test#1",
			"name": "test",
			"type": "REPOSITORY",
			"multiple": false
		}
		]
	}
	]
}

{
  	"data": [
			 {
				"name" : <string>		//The Artifactory instance name
				"url" : <string>,		//The Artifactory instance URL
			 }
			]
}

GET /api/v2/instances
{
	"data": [
	{
		"name": "DRTarget",
		"url": "http://hostname-target/artifactory"
	},
	{
		"name": "Master",
		"url": "http://hostname-master/artifactory"
	},
	{
		"name": "AOL-ClusterNNN-100",
		"url": "https://mycompany.artifactoryonline.org/mycompany
	}
	]
}

{
	"name" : "<instance name>",
	"description": "<description text>",
	"url" : "<instance URL>",
	"username" : "<admin username>",
	"password" : "<admin password>",
	"location" : "<location text>"
}

POST /api/v2/instances
{
	"name" : "Master",
	"description": "description text",
	"url" : "http://artifactory-hostname/artifactory",
	"username" : "admin",
	"password" : "password",
	"location" : "node location"
} 

{
	"description": "<description text>",
	"url" : "<instance URL>",
	"username" : "<admin username>",
	"password" : "<admin password>",
	"location" : "<location text>"
}

POST /api/v2/instances/Master
{
	"description": "new description text",
	"url" : "http://new-artifactory-hostname/artifactory",
	"username" : "new-admin",
	"password" : "new-password",
	"location" : "new node location"
} 

DELETE /api/v2/instances/AOL-ClusterNNN-100

204

{
	"scriptMappings": [
 	{
 		"instanceName": <Artifactory instance>,
 		"scriptNames": [<script names>]
 	}
 	]
} 

{
	"scriptMappings": [
 	{
 		"instanceName": "Master",
 		"scriptNames": [
 			"ldapSettings1", "propertySets1"
 		]
 	}
 	]
}

{
  "data": [
    {
      "instanceName": <instance name>, //String
      "upTimeInSec": <Number of seconds instance has been up>, //Integer (when instanceState is ONLINE)
      "instanceState": <instance state> //String: ONLINE |  OFFLINE | UNAUTHORIZED | ERROR
    }
  ]
}

{
  "data": [
    {
      "instanceName": "test-instance-2",
      "instanceState": "OFFLINE"
    },
    {
      "instanceName": "test-instance-1",
      "upTimeInSec": 1744204,
      "instanceState": "ONLINE"
    }
  ]
}

{
  "data": 
    {
      "instanceName": <instance name>, //String
      "upTimeInSec": <Number of seconds instance has been up>, //Integer (when instanceState is ONLINE)
      "instanceState": <instance state> //String: ONLINE |  OFFLINE | UNAUTHORIZED | ERROR
    }
}

{
  "data": {
      "instanceName": "test-instance-1",
      "upTimeInSec": 1744204,
      "instanceState": "ONLINE"
    }
} 

GET /api/v2/instances/cluster-126-10100/repositories
{
 	"data": [
	{
 		"repositoryKey": "libs-release-local",
 		"description": "",
 		"type": "local",
 		"packageType": "maven"
 	},
 	{
 		"repositoryKey": "libs-snapshot-local",
 		"description": "",
 		"type": "local",
 		"packageType": "maven"
	},
 	{
 		"repositoryKey": "plugins-release-local",
 		"description": "Local repository for plugins",
 		"type": "local",
 		"packageType": "maven"
 	}
 	]
}  

{
	"scriptMappings":[
			  {
+				"instanceName" : <string>,   	//Artifactory instance on which to create the repository
				"scriptNames" : [<string>],  	//scripts to apply when creating the repository				
				"scriptUserInputs": 		//user inputs required for the scripts applied. One of these should refer to the repositoryKey field
				{
					<userInputId> : <user input value> //  userInputId obtained from previous call to userInputs
				}
			  }
			]
}

localRepository('local-default') {
 	description "Public description"
 	notes "Some internal notes"
 	includesPattern "**/*" // default
 	excludesPattern "" // default
 	repoLayoutRef "maven-2-default"
 	packageType "generic" // "maven" | "gradle" | "ivy" | "sbt" | ... | "generic"
 	debianTrivialLayout false
 	checksumPolicyType "client-checksums" // default | "server-generated-checksums"
 	handleReleases true // default
 	handleSnapshots true // default
 	maxUniqueSnapshots 0 // default
 	snapshotVersionBehavior "unique" // "non-unique" default | "deployer"
 	suppressPomConsistencyChecks false // default
 	blackedOut false // default
 	propertySets // (["ps1", "ps2"])
 	archiveBrowsingEnabled false
 	calculateYumMetadata false
 	yumRootDepth 0
}

POST /api/v2/execute_scripts/repositories
{
 	"scriptMappings":[
 	{
 		"instanceName": "DRTarget",
 		"scriptNames":[
 		"local-default"
 		]
 	}
 	]
}

{
	"scriptMappings" :[
			  {
+				"instanceName" : <string>,   //Artifactory instance on which to update the repository
+				"repositoryKey" : <string>,  //Name of the repository to update
				"scriptNames" :[<string>],  //scripts to apply when  updating the repository. The user inputs must be provided in an order that corresponds to the script names.
				"scriptUserInputs" :  //user inputs required for the scripts applied
				{
					<userInputId> : <user input value> //  string or object, depending on the user input type
				}
			  }
			]
}

test = userInput (
	type : "REPOSITORY"
	)
	localRepository('repo-variables') {
 		description test.name
	}

PUT /api/v2/execute_scripts/repositories
{
 	"scriptMappings":[
	 {
 		"instanceName": "Master",
 		"repositoryKey": "ext-release-local",
 		"scriptNames":[
 			"local-repo-userInput"
 		],
 		"scriptUserInputs" : { 
			"TemplateExecutor#0#test#0": {"instanceName": "Master", "repositoryKey": "ext-release-local" }
		}
	}
 	]
}
 
Response:
{
 	"data": [
 	{
 		"success": true,
 		"instanceName": "Master",
 		"repositoryKey": "ext-release-local"
 	}
 	]
} 

{
+	"instanceNames":[<string>],					// The Artifactory instances on which to create this user
+	"user" :
	{
+		"name" : <string>,							// The user's name
+		"email" : <string>,								// The user's email
+		"password" : <string>,						// The user's password in clear-text
		"admin" : <boolean>,								// If true, this is an admin user
		"profileUpdatable" : <boolean>,    			// If true, this user can update their profile
		"internalPasswordDisabled" : <boolean>   	// If true, this user cannot use internal password when external authentication (such as LDAP) is enabled.
	}
}

POST /api/v2/security/users
{
    "instanceNames": ["cluster-121-10100","cluster-126-10100"],
    "user": {
        "name": "johns",
        "email": "johns@somewhere.com",
        "password": "12345678",
        "admin": false,
        "profileUpdatable": false,
        "internalPasswordDisabled":   false
    }
}
 
Response body:
{
 	"data": [
 	{
 		"success": true,
 		"instanceName": "cluster-121-10100"
 	}, 
	{
 		"success": true,
 		"instanceName": "cluster-126-10100"
	}
 ]
}

{
+	"instanceNames":[<string>],			// The Artifactory instances on which to create this user
+	user:
	{
+		"email" : <string>,				// The user's email
		"password" : <string>,			// The user's password in clear-text
		"admin" : <boolean>, // If true, this is an admin user 
		"profileUpdatable" : <boolean>,  // If true, this user can update their profile
		"internalPasswordDisabled" : <boolean>   // If true, this user cannot use internal password when external authentication (such as LDAP) is enabled.
	}
}