Profiles - RESTful API

Summary:

List and create profiles on a specified server.

URL:

http(s)://{server hostname}/api/profile

Methods summary

GET Method detail

POST Method detail

Methods summary

• GET Method - list all the profiles on this server.
• POST Method - create a profile on this server.

GET Method detail

Returns a list of profiles on this server.

Response:

Example:

INPUT
curl -v -u -k admin:admin https://localhost/api/profile?media=json -H "content-type:application/json"

OUTPUT
{
  "items": [
  {
  "id": 1,
  "name": "Test 1",
  "rank": 1,
  "views": [
    8,
    9
    ],
  "osServices": [
    1
  ]
},
  {
  "id": 2,
  "name": "Profile 2",
  "rank": 2,
  "views": [
    9,
    10,
    11
  ],
  "osServices": [
    2
  ]
},
  {
  "id": 3,
  "name": "Profile 3",
  "rank": 3,
  "views": [
    5,
    6
  ],
  "osServices": [
    3
  ]
}
],
  "count": 3
}

POST Method detail

Create a new profile on this server.

Request:

Response:

Details of the profile as the GET Method would return it.

Example:

INPUT
curl -v -u -k admin:admin https://localhost/api/profile?media=json -X POST -H "content-type:application/json" -d \
{
  "name":"Test 6",
  "views": [
    8
  ],
  "osServices": [
    2
  ]
}

OUTPUT
{
  "id": 6,
  "name": "Test 6",
  "rank": 6,
  "views": [
    8
  ],
  "osServices": [
    2
  ]
}