Retrieving a collection of resources
Retrieve a collection of resources by sending a GET request to a collection endpoint.
Request
GET http://{Address_Manager_IP}/api/v2/configurations
Authorization: Basic {basicAuthenticationCredentials}Response
HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"count": 2,
"data": [
{
"id": 100946,
"type": "Configuration",
"name": "config-1",
"description": null,
"configurationGroup": null,
...
"_links": {
"self": {
"href": "/api/v2/configurations/100946"
},
"collection": {
"href": "/api/v2/configurations"
},
"up": {
"href": "/api/v2/1"
},
"accessControlLists": {
"href": "/api/v2/configurations/100946/accessControlLists"
},
"blocks": {
"href": "/api/v2/configurations/100946/blocks"
},
...
}
},
{
"id": 100958,
"type": "Configuration",
"name": "config-2",
"description": null,
"configurationGroup": null,
...
"_links": {
"self": {
"href": "/api/v2/configurations/100958"
},
"collection": {
"href": "/api/v2/configurations"
},
"up": {
"href": "/api/v2/1"
},
"accessControlLists": {
"href": "/api/v2/configurations/100958/accessControlLists"
},
"blocks": {
"href": "/api/v2/configurations/100958/blocks"
},
...
}
}
]
}Retrieving a single resource
Retrieve a single resource by sending a GET request to the resources URI.
Tip: A resource’s URI can be found in its
_links.self.href field when
the response media type is application/json+hal.Request
GET http://{Address_Manager_IP}/api/v2/configurations/100946
Authorization: Basic {basicAuthenticationCredentials}Response
HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"id": 100946,
"type": "Configuration",
"name": "config-1",
"description": null,
"configurationGroup": null,
...
"_links": {
"self": {
"href": "/api/v2/configurations/100946"
},
"collection": {
"href": "/api/v2/configurations"
},
"up": {
"href": "/api/v2/1"
},
"accessControlLists": {
"href": "/api/v2/configurations/100946/accessControlLists"
},
"blocks": {
"href": "/api/v2/configurations/100946/blocks"
},
...
}
}