Mission Control REST API

Overview

Mission Control exposes a rich REST API to allow fully automated management of registered JFrog Platform Deployments (JPDs).

This provides a convenient and up-to-date self-descriptive API and can be used by various tools to automate administration and configuration actions.

Authentication

Mission Control's REST API supports authentication types:

Type

Description

Access Token

Users have to use access token as a bearer token in the authorization header.

Example of authentication using the Bearer token:

1. Create the Access Token to use for MC:
  http --form POST http:///access/api/v1/oauth/token "username=" scope="applied-permissions/user" "audience=jfmc@*" "expires_in=0" "refreshable=true" "grant_type=client_credentials" "Authorization: Bearer
2. ```
Run curl -H 'Authorization: Bearer http://localhost:8081/mc/api/v1/jpds
```

Usage

Mission Control REST API can be invoked in any of the standard ways for a REST API.The following section describes how to use the Mission Control REST API using cURL as an example.

Using and configuring cURL

You can download cURL here. Learn how to use and configure cURL here.

Example - Create JPD

The example below demonstrates how to invoke the create userREST API.

You have MissionControl running on your local system, on port 8080
You wish to create a site called "us-west" containing both anArtifactory and Xray.
You created a file with the site's parameters calledcreatejpd.json

To use the file to create a new user, you would use the following command:

Using cURL with the REST API

$ curl 'http://localhost:8081/mc/api/v1/jpds' -i -H 'Authorization: Bearer ' -X POST -H 'Content-Type: application/json; charset=UTF-8' -T createjpd.json

The file createsite.json will contain the following :

{ "name": "us-west", "url" : "http://somehost", "token" : "xxx", "location": { "city": "Sunnyvale", "country_code": "US", "latitude": 37.368830, "longitude": -122.036350 } }

Page Contents

Read More

SYSTEM

System Health Check

Description: Get an indication if Mission Control is running or not. No authentication required.
Since:4.0
Usage:GET /api/v1/ping
Example:

GET /api/v1/ping true

PROXIES

Update proxy

Description:Proxies are defined in Artifactory, this request adds a JPD pair to an existing proxy. Those JPDs are referenced with their id, see get JPD call (TODO: link here)

Since:4.0

Security:Requires an admin user

Usage:PUT /api/v1/proxies/

Consumes:application/json

Example:

POST /mc/api/v1/proxies/squid HTTP/1.1 [{ "source" : "JPD-1", "destination" : "JPD-2" }, { "source" : "JPD-1", "destination" : "JPD-3" } ]

Example:

$ curl 'http://localhost:8081/mc/api/v1/proxies' -i -H 'Authorization: Bearer ' -X PUT -H 'Content-Type: application/json; charset=UTF-8' -d '[{ "source" : "JPD-1", "destination" : "JPD-2" }, { "source" : "JPD-1", "destination" : "JPD-3" } ]'

Get List of Proxies

Description:Get the list of proxies.
Since:4.0
Security:Requires an admin user
Usage:Get /api/v1/proxies
Consumes:application/json

Example:

GET /mc/api/v1/proxies HTTP/1.1 [ { "key" : "proxy-01", "host" : "host1", "port" : 3128, "username" : "user", "password" : "xxx", "nt_host" : "host", "nt_domain" : "domain", "jpu_pairs" : [{ "source" : "JPD-1", "destination" : "JPD-2" }] }, { "key" : "proxy-02", "host" : "host1", "port" : 3128, "jpu_pairs" : [{ "source" : "JPD-1", "destination" : "JPD-3" }] } ]

Command line:

$ curl 'http://localhost:8081/mc/api/v1/proxies' -i -H 'Authorization: Bearer ' -H 'Content-Type: application/json; charset=UTF-8'

Get List of Proxies Filtered by Source JPD

Description:Get the list of proxies by source JPD.
Since:4.0
Security:Requires an admin user
Usage:GET /mc/api/v1/proxies?source={JPD_name}
Consumes:application/json

Example:

GET /mc/api/v1/proxies?source=JPD-12 HTTP/1.1 [ { "key" : "proxy-01", "host" : "host1", "port" : 3128, "jpu_pairs" : [{ "source" : "JPD-12", "destination" : "JPD-3" }] } ]

Get List of Proxies Filtered by Destination JPD

Description:Get the list of proxies filtered by destination JPD.
Since:4.0
Security:Requires an admin user
Usage:GET /mc/api/v1/proxies?destination={destination_JPD_name}
Consumes:application/json

Example:

GET /mc/api/v1/proxies?destination=JPD-12 HTTP/1.1 [ { "key" : "proxy-03", "host" : "host3", "port" : 3128, "jpu_pairs" : [{ "source" : "JPD-1", "destination" : "JPD-12" }] } ]

Get List of Proxies Filtered by Source and Destination JPD

Description:Get the list of proxies by source JPD.

Since:3.2

Security:Requires an admin user

Usage:GET /mc/api/v1/proxies?source={source_JPD_name}&destination={destination_JPD_name}

Consumes:application/json

Example:

GET /mc/api/v1/proxies?source=JPD-12&destination=JDP-13 [ { "key" : "proxy-04", "host" : "host4", "port" : 3128, "jpu_pairs" : [{ "source" : "JPD-12", "destination" : "JPD-13" }] } ]

Get Proxy by Name

Description:Get a proxy by name.
Since:4.0
Security:Requires an admin user
Usage:GET /mc/api/v1/proxies/{name}
Consumes:application/json

Example:

GET /mc/api/v1/proxies/proxy-01 HTTP/1.1 { "key" : "proxy-01", "host" : "host1", "port" : 3128, "jpu_pairs" : [{ "source" : "JPD-1", "destination" : "JPD-3" }] }

JPDs

Add JPD

Description:Adds a new JPD to Mission Control.

Since:4.0

Security:Requires an admin user

Usage:POST/mc/api/v1/jpd s

Return codes:

201 - Created
400 -Failed to connect to the JPD. Please verify that the JPD information provided is correct
409 - Conflicts with an existing JPD (URL, name)

Consumes:application/json

{ "name" : "JDP-12", "url" : "http://jpd:8080/test", "token" : "some-token", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" }

Example:

$ curl 'http://localhost:8081/mc/api/v1/jpds' -i -H 'Authorization: Bearer ' -X POST -H 'Content-Type: application/json; charset=UTF-8' -T create_JPD.json

create_JPD.json

{ "name" : "dev-west", "url" : "https://artifactory-west.acme.com/artifactory", "token" : "", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" } 201 Created

Update JPD

Description:Updates a JPD

Since:4.0

Security:Requires an admin user

Usage:PUT /mc/api/v1/jpds/{name}

Return codes:

204 - No Content
400 -Failed to connect to the JPD. Please verify that the JPD information provided is correct
409 - Conflicts with an existing JPD (URL, name)

Consumes:application/json

{ "name" : "", "url" : "", "token" : "some-token", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" }

Example:

$ curl 'http://localhost:8080/api/v1/jpds/JPD-3' -i -X -H 'Authorization: Bearer ' PUT \

updateservice.json

{ "name" : "new_name", "url" : "http://new-jpd-url:8080/jpd.test", "location" : { "city_name" : "Toulouse", "country_code" : "FR", "latitude" : 43.6043, "longitude" : 1.4437 }, "proxy_key" : "proxy1" }

Get JPD List

Description:Get a list of all JPDs

Since:4.0

Security:Requires an admin user

Usage:GET /mc/api/v1/jpds/

Produces:application/json

Example:

$ curl -XGET 'http://localhost:8080/mc/api/v1/jpds' -H 'Authorization: Bearer '

example output

[ { "name" : "JDP-12", "url" : "http://jpd12:8080/test", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" }, { "name" : "JDP-13", "url" : "http://jpd13:8080/test", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" } ] 200 Success

Get List of JPDs with Proxy Based on Source

Description:Gets the list of JPDs managed by Mission Control with proxy

Since:4.0

Security:Requires an admin user

Usage:GET request to /mc/api/v1/jpds?source=Source

Consumes:application/json

Example:

[ { "name" : "JDP-12", "url" : "http://jpd12:8080/test", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" }, { "name" : "JDP-13", "url" : "http://jpd13:8080/test", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" } ] 200 Success

Get JPD by Name with Proxy based on Source

Description:Get JPD by name managed by Mission Control with proxy.

Since:4.0

Security:Requires an admin user

Usage:GET /mc/api/v1/jpds/{name}?source=

Example:

GET /api/v1/jpds/JPD-12?source=JPD-13 { "name" : "JDP-13", "url" : "http://jpd13:8080/test", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "proxy_key" : "proxy1" }

Delete JPD

Description:Removes a JPD from Mission Control

Since:4.0

Security:Requires an admin user

Usage:DELETE/mc/api/v1/jpds/{id}

Return codes:

200 - Success
204 - No content
404 - Not found

Example:

$ curl 'http://localhost:8081/mc/api/v1/jpds/JPD-321' -i -X DELETE \

ACCESS FEDERATION

Get Access Federation Configuration for a Single JPD

Description:Gets the Access Federation configuration for a specific JPD. Returns the Federation targets configured for the provided JPD.

Since:4.0

Security:Requires an admin user

Usage:GET /mc/api/v1/federation/{JPD ID}

Return codes:

200 - Success
400 - The JPD is not a valid Access Federation candidate.
404 - The JPD was not found.
Consumes:application/json

Request Example:

GET /mc/api/v1/federation/JPD-1 HTTP/1.1

Response Example:

{ "entities" : [ "GROUPS", "USERS" ], "targets" : [ { "name" : "JFP-2", "code" : "access2JPDId", "url" : "http://localhost:37837/access" } ] }

Get Access Federation Configuration for All JPDs

Description:Gets the Access Federation configurations for all the JPDs.

Since:4.0

Security:Requires an admin user

Usage:GET /mc/api/v1/jpds/federation?includeNonConfiguredJPDs=false

Return codes:

200 - Success

Produces:application/json

Request Example:

GET /mc/api/v1/federation?include_non_configured=false HTTP/1.1

Response Example:

[ { "source" : "artifactory1", "entities" : [ "GROUPS", "USERS" ], "targets" : [ { "name" : "JPD-2", "code" : "access2JPDId", "url" : "url2" } ] } ]

Configure Access Federation on a JPD

Description:Configures Access Federation for a specific JPD. As a pre-requisite, the source and targets must have been configured properly for Access Federation based onthis.
Since:4.0
Security:Requires an admin user
Usage:PUT /mc/api/v1/jpds/{JPD ID}/federation

Return codes:

200 - Success
400, 422 - Invalid input
404 - JPD not found or not an Artifactory

Example Request:

PUT /mc/api/v1/federation/JPD-12 HTTP/1.1 { "entities" : [ "USERS", "GROUPS" ], "targets" : [ { "name" : "artifactory2", "url" : "http://localhost:8080/access" } ] }

Example Response:

[ { "label" : "Get configuration of artifactory1", "status" : "OK" }, { "label" : "Get Access token from artifactory1", "status" : "OK" }, { "label" : "Check if artifactory2 trusts artifactory1", "status" : "OK" }, { "label" : "Send configuration to artifactory1", "status" : "OK" }, { "label" : "Add target artifactory2 to artifactory1", "status" : "OK" } ]

Get Access Federation Candidates

Description:Gets the Access Federation candidates.
Since:4.0
Security:Requires an admin user
Usage:GET /mc/api/v1/federation/candidates

Return codes:
200 - Success

Request Example:

GET /mc/api/v1/federation/candidates HTTP/1.1

Response Example:

["JPD-12", "JPD-13"]

Create Mesh

Description:Creates a mesh topology.As a pre-requisite, the source and targets must have been configured properly for Access Federation based onthis.

Since:4.0
Security:Requires an admin user
Usage:POST /mc/api/v1/federation/create_mesh
Return codes:

200 - Success
400, 422 - Invalid input
404 - JPD not found or not an Artifactory

Request Example:

POST /mc/api/v1/federation/create_mesh HTTP/1.1

Response Example:

{ "jpds": [ "JPD-12", "JPD-13" ], "entities": [ "USERS", "GROUPS", "PERMISSIONS", "TOKENS" ] }

SUPPORT

Create Support Bundle

Description: Create a new support bundle.
Since:4.0
Security:Requires an admin user
Notes: All bundle items are optional.
Usage: POST /mc/api/v1/system/support/bundle

Return codes:
202 - Support bundle is being created and will be available soon
400 - Invalid option values
403 - Unauthorized

Sample Usage:

POST /mc/api/v1/system/support/bundle HTTP/1.1 { "name" : "My support bundle", "description" : "Support bundle generated because of issue XYZ", "parameters" : { "configuration" : true, "system" : true, "logs" : { "include" : true, "start_date" : "2018-09-19", "end_date" : "2018-09-20" }, "thread_dump" : { "count" : 1, "interval" : 0 } } }

Example:

$ curl -X POST -H 'Authorization: Bearer ' https://my-mission-control.jfrogdev.co/api/v1/system/support/bundle -H 'Content-Type: application/json' \ -d '{ "name": "JFMC support bundle", "description": "Support bundle generated because of issue with XYZ", "parameters": { "configuration": true, "system": true, "thread_dump": { "count": 1, "interval": 0 }, "logs": { "include": true, "start_date": "2018-12-25", "end_date": "2019-01-07" } } }'

Example Output:

HTTP/1.1 202 Accepted Content-Type: application/json Server: mission-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 247 { "id" : "SUPP20180912154413548991", "artifactory" : { "service_id" : "jfrt@4754684682741", "bundle_url" : "http://artifactory.www.si-fil.com/artifactory/jfrog-support-bundle/SUPP20180912154413548991/jfmc/test_JPD } }

Get Support Bundles List

Description: Get the list of available support bundles.
Since:4.0
Security:Requires an admin user
Usage: GET /mc/api/v1/system/support/bundles

Return codes:
200 - Successful
403 - Unauthorized

Example:

GET /mc/api/v1/system/support/bundles HTTP/1.1

Response:

{ "count" : 2, "bundles" : [ { "name" : "A", "description" : "aaa", "id" : "1", "created" : "2018-10-01T09:50:11Z" }, { "name" : "B", "id" : "2", "created" : "2018-10-01T09:50:11Z" } ] }

Get Details of a Support Bundle

Description:被一个特定的细节支持包。
Since:4.0
Security:Requires an admin user
Usage: GET/mc/api/v1/system/support/bundle/{id}

Return codes:
200 - Successful
403 - Unauthorized
404 - Supplied ID does not refer to an existing support bundle

Example:

GET /mc/api/v1/system/support/bundle/SUPP20180912154413548991 HTTP/1.1

Response:

{ "name" : "issue #1234", "description" : "Support bundle created for issue #1234 investigation", "artifactory" : { "service_id" : "jfrt@4754684682741", "bundle_url" : "http://artifactory.www.si-fil.com/artifactory/jfrog-admin-supportbundle/SUPP20180912154413548991/jfmc/01c7b8rg70nrqr1cck7k4x0yp7" }, "parameters" : { "configuration" : true, "system" : true, "logs" : { "include" : true, "start_date" : "2018-09-30", "end_date" : "2018-10-01" }, "thread_dump" : { "count" : 1, "interval" : 0 } }, "available" : 5, "created" : "2018-10-01T09:50:10Z" }

Download Support Bundle

Description: Downloads a support bundle as a ZIP file.
Since:4.0
Security:Requires an admin user.You need to have the "Download folder" permission enabled on Artifactory.
Usage: GET/mc/api/v1/system/support/bundle/{id}/archive

Return codes:
200 - Successful
403 - Unauthorized (it may be that the "Download folder" option is not enabled on the Authentication Provider Artifactory)
404 - Supplied ID does not refer to an existing support bundle or the ZIP cannot be found in the Authentication Provider Artifactory repository

Example:

GET /mc/api/v1/system/support/bundle/SUPP20180912154413548991/archive HTTP/1.1

Delete Support Bundle

Description: Deletes a support bundle, along with the ZIP file in Artifactory.
Since:4.0
Security:Requires an admin user
Usage: DELETE/mc/api/v1/system/support/bundle/{id}

Return codes:
204 - Successful
403 - Unauthorized
404 - Supplied ID does not refer to an existing support bundle

Example:

DELETE /mc/api/v1/system/support/bundle/SUPP20180912154413548991 HTTP/1.1

Create Platform Support Bundle

Description: Create a new support bundle.create support bundle for several JPDs
Since:4.0
Security:Requires an admin user
Usage: POST /mc/api/v1/platform/support/bundle

Return codes:

200 - Support bundle is being created and will be available soon
422 - JPD list empty or too large
504 - Timeout
400 - Invalid Request

Sample Usage:

POST /mc/api/v1/system/support/bundle HTTP/1.1 { "name" : "my_support_bundle", "description" : "Platform Support Bundle test description", "services" : [ "self", "jfrt@64845741457245711" ], "parameters" : { "configuration" : true, "system" : true, "logs" : { "include" : true, "start_date" : "2019-03-14", "end_date" : "2019-03-15" }, "thread_dump" : { "count" : 1, "interval" : 0 } } }

Example Output:

example output

200 OK - type: application / json服务器:小姐ion-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 487 { "id" : "20190315-1624-cab48ff6-33e4-4e17-b2c9-845a71ffa3a7", "locations" : [ { "service_id" : "jfrt@01d612nxv8yfcn119xsj7d1jrz", "artifactory" : { "service_id" : "jfrt@other.www.si-fil.com", "bundle_url" : "http://other.www.si-fil.com/artifactory/" } }, { "service_id" : "jfmc@01c7b8rg70nrqr1cck7k4x0yp7", "artifactory" : { "service_id" : "jfrt@auth-provider.www.si-fil.com", "bundle_url" : "http://auth-provider.www.si-fil.com/artifactory/" } } ] }

Get Platform Support Bundles List

Description: Gets a list of previously created support bundles.
Since:4.0
Security:Requires an admin user
Usage: GET /mc/api/v1/platform/support/bundles

Return codes:

200 - OK
400 - Invalid Request

Sample Usage:

GET /mc/api/v1/platform/support/bundles HTTP/1.1 Authorization: Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json; charset=UTF-8 Host: localhost:8080

Example Output:

HTTP/1.1 200 OK Content-Type: application/json Server: mission-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 319 { "bundles" : [ { "id" : "20190218-1554-c5043f76-4d6d-49e2-9ab7-2999b7af02ef", "name" : "sb-name", "description" : "sb-description", "created" : "2019-02-18T15:54:00Z" }, { "id" : "20190218-1553-bb12b2e0-3b16-44aa-889a-513c14976542", "created" : "2019-02-18T15:53:00Z" } ], "count" : 2 }

Get Platform Support Bundle Metadata

Description: Gets the metadata for a previously created support bundle.
Since:3.5
Security:Requires an admin user
Usage: GET /mc/api/v1/system/support/bundle/{id}

Return codes:

200 - OK
400 - Invalid Request

Sample Usage:

GET / mc / api / v1 /平台/支持/包/ 20190218 - 15所示54-88722539-78af-41bc-a5d7-e7567fb7189f HTTP/1.1 Authorization: Bearer xxx Content-Type: application/json; charset=UTF-8 Host: localhost:8081

Example Output:

HTTP/1.1 200 OK Content-Type: application/json Server: mission-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 742 { "id" : "20190218-1554-88722539-78af-41bc-a5d7-e7567fb7189f", "name" : "sb-name", "description" : "sb-description", "status" : "success", "created" : "2019-02-18T15:54:00Z", "parameters" : { "configuration" : true, "system" : true, "logs" : { "include" : true, "start_date" : "2019-03-14", "end_date" : "2019-03-15" }, "thread_dump" : { "count" : 1, "interval" : 0 } }, "locations" : [ { "service_id" : "jfxr@2222", "artifactory" : { "service_id" : "jfrt@jfxr", "bundle_url" : "https://art.jfxr" } }, { "service_id" : "jfds@1111", "artifactory" : { "service_id" : "jfrt@jfds", "bundle_url" : "https://arti.jfds" } } ] }

Get Platform Support Bundle

Description: Downloads a previously created support bundle as a ZIP file.
Since:4.0
Security:Requires an admin user
Usage: GET /mc/api/v1/platform/support/bundle/{id}/archive

Return codes:

200 - Support bundle zip will be downloaded
400 - Invalid Request

Sample Usage:

GET / mc / api / v1 /平台/支持/包/ 20190218 - 15所示53-2ea5aa8c-0ee7-4981-9028-d19c653b423a/archive HTTP/1.1 Authorization: Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json; charset=UTF-8 Host: localhost:8081

Example Output:

HTTP/1.1 200 OK Content-Disposition: attachment; filename="20190218-1553-2ea5aa8c-0ee7-4981-9028-d19c653b423a.zip" Content-Type: application/zip Server: mission-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 28

Delete Platform Support Bundle

Description: Deletes a previously created support bundle, along with the ZIP file in Artifactory.
Since:4.0
Security:Requires an admin user
Usage: DELETE /mc/api/v1/platform/support/bundle/{id}

Return codes:

200 - Support bundle successfully deleted
404 - Support bundle id not found or invalid
500 - Support could not be deleted

Sample Usage:

DELETE /mc/api/v1/platform/support/bundle/20190218-1554-7d3f4afa-a129-435e-822a-d19a052f9b4a HTTP/1.1 Authorization: Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json; charset=UTF-8 Host: localhost:8081

Example Output:

HTTP/1.1 200 OK Content-Type: application/json Server: mission-control/SNAPSHOT Strict-Transport-Security: max-age=31536000; includeSubDomains Content-Length: 110 { "deleted" : [ "jfmc@01c7b8rg70nrqr1cck7k4x0yp7", "jfrt@01d612qkz4bjqt0e36d13s1ry5" ], "failures" : [ ] }

LICENSE BUCKETS

Get Buckets

Description:Retrieves all the license buckets in the system.

Since:4.0

Security:Requires an admin user

Usage:GET /mc/api/v1/buckets

Return codes:

200 - Success

Produces:application/json

[{“标识符”:“<桶id >”,“名字”:“< bucket name>", "size" : , "license_type": "" } ]

Sample Usage:

GET /mc/api/v1/buckets [ { "id" : "12345", "name" : "bucket-test-1", "size" : 10, "license_type": "ENTERPRISE" }, { "id" : "1234567", "name": "bucket-test-2", "size" : 5, "license_type": "EDGE" } ]

Create Bucket

Description:Creates a new License Bucket.

Since:4.0

Security:Requires an admin user

Usage:POST /mc/api/v1/buckets

Return codes:

201 - Created
409 - Name '' already exists
409 - Url '' already exists

Consumes:application/json

{ "name" : "", "url" : "", "key" : "" }

Example:

$ curl 'http://localhost:8081/mc/api/v1/buckets' -i -H 'Authorization: Bearer ' -X POST -H 'Content-Type: application/json; charset=UTF-8' -T createbucket.json

createbucket.json

{ "name" : "main-bucket", "url" : "https://bintray.www.si-fil.com/license-buckets/test_www.si-fil.com/12345678/12345678.json?expiry=1528199600307&id=ABCDEFGhiJkLmNoPQR", "key" : "16629dbf7fefc9d179b36ba005685c2dd8376aad3278178e735da1633c6bd3c6" }

201 Created { "subject" : "JFrog", "product_name" : "Artifactory", "product_id" : 6, "license_type" : "HA", "issued_date" : "2018-04-12T16:02:55.549+03:00", "valid_date" : "2019-04-12T16:02:54.759+03:00", "quantity" : 10, "signature" : "06307c34405e6ab70c5d249a7ba7cffd81947d5f", "name" : "main-bucket", "used" : 0, "url" : "https://bintray.www.si-fil.com/license-buckets/test_www.si-fil.com/12345678/12345678.json?expiry=1528199600307&id=ABCDEFGhiJkLmNoPQR" }

Upload Bucket

Description:Uploads and creates a new License Bucket.
Since:4.0
Security:Requires an admin user
Usage:POST /mc/api/v1/buckets
Content-Type:multipart/form-data

Return codes:

201 - Created
400 - Your bucket file could not be used. Please verify that the file is correct and that the key is valid.
409 - Name '' already exists

Consumes:application/json

name | Bucket’s name in Mission Control file | Path to the bucket file key | Key used to decrypt the bucket

Produces:application/json

{“主题”:“JFrog”,“product_name”:“Artifactory", "product_id" : 6, "license_type" : "HA", "issued_date" : "2016-04-12T16:02:55.549+03:00", "valid_date" : "2017-04-12T16:02:54.759+03:00", "quantity" : 10, "identifier" : "bucket-test-1", "signature" : "06307c34405e6ab70c5d249a7ba7cffd81947d5f", "name" : "Test-bucket-name", "used" : 0 }

Example:

curl 'http://localhost:8081/mc/api/v1/buckets' -i -H 'Authorization: Bearer ' -X POST -H 'Content-Type: multipart/form-data' -F 'file=@/tmp/728939433.json;type=application/octet-stream' -F 'key=d18fc5bc05dc3b6419ab6cd127f16cf6b57d7650ea0ef03cde130918f6f25487' -F 'name=mybucket'

Delete Bucket

Description:Deletes a bucket.
Since:4.0
Security: Requires an admin user
Usage:DELETE /mc/api/v1/buckets/{name}
Return codes:204 - Success

Example:

$ curl -XDELETE 'http://localhost:8081/mc/api/v1/buckets/main-bucket' -H 'Authorization: Bearer ' -H "Content-Type: application/json" 204 No Content

Get Bucket Status

Description:Get the report for a specified bucket.
Since:4.0
Security:Requires an admin user
Usage:GET /api/v1/buckets/{identifier}/report
Produces:application/json

Example:

{ "identifier": "", "name": , "size": , "valid_through": , "issued": , "type": , "licenses": { "used": , "available": , "max_used":  } }

Return codes:

200 - Success

Example:

$ curl -XGET 'http://localhost:8081/mc/api/v1/buckets/415921223/report' -i -H 'Authorization: Bearer '

example output

{ "identifier": "266200796", "name": "edge-bucket", "size": 10, "valid_through": "2020-02-14T00:00:00.000Z", "issued": "2019-02-14T14:27:29.584Z", "type": "EDGE_TRIAL", "licenses": { "used": 0, "available": 10, "max_used": 0 } } 200 Success

Attach License

Description:Attaches a license from a bucket to the specified JPD.

Since:4.0

Security:Requires an admin user

Usage:POST /mc/api/v1/buckets/{name}/deploy

Consumes:application/json

{ "name" : "JPD-12", "license_count" :  }

Produces:application/json

Return codes:

200 - Success

409 - "Deployment of multiple license is supported for cluster only"

Example:

$ curl -POST 'http://localhost:8081/mc/api/v1/buckets/{name}/deploy' -i -H 'Authorization: Bearer ' -H 'Content-Type: application/json; charset=UTF-8' -T attachlicense.json

attachlicense.json

{ "name" : "JPD-12", "license_count" : 1 }

Since deploy is false, the response will return a license_key

example output

{ "license_key" : "" }

Example:

$ curl 'http://localhost:8080/mc/api/v1/buckets/{name}/deploy' -i -X POST -H 'Content-Type: application/json; charset=UTF-8' -T attachlicense.json

attachlicense.json

{ "license_count" : 5, "name" : "JPD-12" }

This applies 5 licenses to the Artifactory in the specified Platform Deployment. Even if there are only 3 nodes available in the Artifactory cluster, 5 licenses will be applied.

Content

Space Tools

Mission Control REST API

Overview

Authentication

Using and configuring cURL

Example - Create JPD

SYSTEM

System Health Check

PROXIES

Update proxy

Get List of Proxies

Get List of Proxies Filtered by Source JPD

Get List of Proxies Filtered by Destination JPD

Get List of Proxies Filtered by Source and Destination JPD

Get Proxy by Name

JPDs

Add JPD

Update JPD

Get JPD List

Get List of JPDs with Proxy Based on Source

Get JPD by Name with Proxy based on Source

Delete JPD

ACCESS FEDERATION

Get Access Federation Configuration for a Single JPD

Get Access Federation Configuration for All JPDs

Configure Access Federation on a JPD

Get Access Federation Candidates

Create Mesh

SUPPORT

Create Support Bundle

Get Support Bundles List

Get Details of a Support Bundle

Download Support Bundle

Delete Support Bundle

Create Platform Support Bundle

Get Platform Support Bundles List

Get Platform Support Bundle Metadata

Get Platform Support Bundle

Delete Platform Support Bundle

LICENSE BUCKETS

Get Buckets

Create Bucket

Upload Bucket

Delete Bucket

Get Bucket Status

Attach License