Dependencies¶

Resource	Operation	Description
DELETE	DELETE /v1/teams/(team_id)/labels/(label)/nodes/(path:node)	Delete a node.
GET	GET /v1/teams/(team_id)/labels/(label)/nodes/(path:node)/impacted/count	Count the total number of nodes impacted by a given node.
	GET /v1/teams/(team_id)/labels/(label)/nodes/(path:node)/impacted/all	Get a JSON payload containing all nodes impacted by a given node.
	GET /v1/teams/(team_id)/labels/(label)/nodes/(path:node)/impacted	Get the nodes impacted by a given node.
	GET /v1/teams/(team_id)/labels/(label)/nodes/(path:node)/count	Count the dependencies of a node.
	GET /v1/teams/(team_id)/labels/(label)/nodes/(path:node)	Get the dependencies of a node.
	GET /v1/teams/(team_id)/labels/(label)/nodes	Get the nodes of a label.
	GET /v1/teams/(team_id)/labels	Get the labels of a team.

GET /v1/teams/(team_id)/labels/(label)/nodes/(path: node)/impacted/count¶

Count the total number of nodes impacted by a given node.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Website/nodes/example.com/impacted/count?impactedLabel=Offer HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

{
  "count": 1
}

Response Headers:
Parameters:	impactedLabel – impacted nodes for the given label
	Content-Type – application/json
Status Codes:	200 OK – the array of impacted nodes

GET /v1/teams/(team_id)/labels/(label)/nodes/(path: node)/impacted/all¶

Get a JSON payload containing all nodes impacted by a given node.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Apache/nodes/apache2/impacted/all?impactedLabel=Offer&ts=1564645344 HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

[
  {
    "active": true,
    "from": null,
    "name": "premium",
    "to": null
  }
]

Response Headers:
Parameters:	impactedLabel – impacted nodes for the given label ts – unix timestamp to check if the nodes are active or not at this timestamp inactive – return inactive impacted nodes in the downloaded file or not (default is False)
	Content-Type – application/json
Status Codes:	200 OK – the array of impacted nodes

GET /v1/teams/(team_id)/labels/(label)/nodes/(path: node)/impacted¶

Get the nodes impacted by a given node.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Apache/nodes/apache2/impacted?impactedLabel=Offer&skip=0&limit=25&ts=1564645111 HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

[
  {
    "active": true,
    "from": null,
    "name": "premium",
    "to": null
  }
]

Response Headers:
Parameters:	impactedLabel – impacted nodes for the given label skip – skip the given number of values (default is 0) limit – limit to the given number of values (default is 25) ts – unix timestamp to check if the nodes are active or not at this timestamp
	Content-Type – application/json
Status Codes:	200 OK – the array of impacted nodes

GET /v1/teams/(team_id)/labels/(label)/nodes/(path: node)/count¶

Count the dependencies of a node.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/MyLabel/nodes/mynode/count HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

{
  'count': 10
}

Response Headers:
	Content-Type – application/json
Status Codes:	200 OK – the number of dependencies

GET /v1/teams/(team_id)/labels/(label)/nodes/(path: node)¶

Get the dependencies of a node.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Website/nodes/example.com HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

{
  "dependencies": {
    "Apache": [{
      "name": "apache1",
      "old": false,
      "periods": [0]
    }],
    "Filer": [{
      "name": "filer1",
      "old": false,
      "periods": [0]
    }],
    "Website": [{
        "name": "example.com"
     }]
  },
  "graph": {
    "nodes": [{
      "id": 8226314,
      "label": "example.com",
      "title": "Website"
    }, {
      "id": 8226318,
      "label": "apache1",
      "title": "Apache"
    }, {
      "id": 8226316,
      "label": "filer1",
      "title": "Filer"
    }],
    "relationships": [{
      "arrows": "to",
      "from": 8226314,
      "id": 13558159,
      "periods": [0],
      "to": 8226318
    }, {
      "arrows": "to",
      "from": 8226314,
      "id": 13558157,
      "periods": [0],
      "to": 8226316
    }]
  },
  "name": "example.com"
}

Response Headers:
Parameters:	alone – Returns the node without its dependencies day – Filter by day (default is today) config – Only include labels used in configuration inactive – Include the inactive nodes impacted – Display the impacted nodes
	Content-Type – application/json
Status Codes:	200 OK – the list of dependencies

DELETE /v1/teams/(team_id)/labels/(label)/nodes/(path: node)¶

Delete a node.

Example request:

DELETE /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Website/nodes/example.com HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

{}

Response Headers:
	Content-Type – application/json
Parameters:	detach – Remove the relations of the node
Status Codes:	200 OK – the node has been deleted

GET /v1/teams/(team_id)/labels/(label)/nodes¶

Get the nodes of a label.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels/Website/nodes HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

[
  "example-one.com",
  "example-two.com"
]

Response Headers:
Parameters:	name – Filter the list by name limit – Limit the number of results random – Return random items
	Content-Type – application/json
Status Codes:	200 OK – the list of nodes

GET /v1/teams/(team_id)/labels¶

Get the labels of a team.

Example request:

GET /v1/teams/66859c4a-3e0a-4968-a5a4-4c3b8662acb7/labels HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK

[
  {
    "name": "Filer",
    "nodes_count": 2,
    "qos_query": "rule.Servers"
  },
  {
    "name": "Website",
    "nodes_count": 2,
    "qos_query": "operation.AND[Filer, Apache]"
  },
  {
    "name": "Apache",
    "nodes_count": 2,
    "qos_query": "rule.Servers"
  },
  {
    "name": "Offer",
    "nodes_count": 1,
    "qos_query": "aggregation.AVERAGE[Website]"
  }
]

Response Headers:
	Content-Type – application/json
Status Codes:	200 OK – the list of labels