Snaplex Version APIs

On this Page

SnapLogic APIs

The following SnapLogic APIs enable you to manage Snaplex versions programmatically.

GET /api/1/rest/public/snaplex/version/

Requests all current package versions.

Example: 

https://elastic.snaplogic.com/api/1/rest/public/snaplex/version

The response contains all versions of Snaplex packages.

Sample Response
{
"response map":{
	"entries" [
	{
		"comment":"xxx", 
		"status":"active",
		"version":"main-xxx"
	},
	...]

"http_status_code": 200}

}

GET /api/1/rest/public/snaplex/version/latest

Requests the latest active Snaplex package version.

Example:

https://elastic.snaplogic.com/api/1/rest/public/snaplex/version/latest

The response contains the latest available version.

Sample Response
{
"response map":{
	"entries" [
	{
		"version":"main-xxx", 
		"comment":"xxx", 
		"status":"active"
	},
	...]
	
	"http_status_code": 200}
}

POST /api/1/rest/public/snaplex/version/<snaplex_path>

Updates the target Snaplex to the target version.

You must be an Org admin to use this API.

Example:

https://elastic.snaplogic.com/api/1/rest/public/snaplex/version/<snaplex_path>

Parameters:

  • url: asset path to the Snaplex <snaplex_path>


Sample Request Body
{
	"version": "main-4403"
}


Sample Response
{
"response map":{
	"entries" [
	{
		"label":"xxx", 
		"org":"xxx", 
		"environment":"xxx", 
		"snode_id":"xxx", 
		"version":"xxx"
	},
	...]
"http_status_code": 200}
}

POST /api/1/rest/public/snaplex/version/latest/<snaplex_path>

Updates the target Snaplex to the latest version available.

You must be an Org admin to use this API.

Example: 

https://elastic.snaplogic.com/api/1/rest/public/snaplex/version/latest/<snaplex_path>

Parameters:

  • url: <snaplex_path>

See the previous Sample Response for an example.