Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Lists all current tokens and their authorization.

GET /rest/agent-config/1.0/tokens/
Expand
Code Block
languagejs
titleResponse
[
  {
    "uuid": "d0ea6653-05e2-4d51-9d89-665cdfe86be6",
    "name": "readOnly",
    "read": true,
    "change": false
  },
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "read and write",
    "read": true,
    "change": true
  }
]

 

Create Token

Returns full details of the requested token, including assigned UUID.

POST /rest/agent-config/1.0/tokens/
Expand
titleClick here to expand to see request...
Code Block
languagejs
titleResponse
  {
    "name": "informational name",
    "read": true,
    "change": false
  }

Note: Response mirrors request but includes the UUID.

Expand
titleClick here to expand response...
Code Block
languagejs
titleResponse
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "informational name",
    "read": true,
    "change": false
  }

Update Token

Alter the name, or permissions of an existing token.

PUT /rest/agent-config/1.0/tokens/{tokenId}
Expand
titleClick here to expand to see request...
Code Block
languagejs
titleResponse
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

Note: Response mirrors request 

Expand
titleClick here to expand response...
Code Block
languagejs
titleResponse
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

 

Pre v1.5

Expand
titleClick here to expand url paths for < 1.5

View All Tokens

Lists all current tokens and their authorization.

GET /rest/agent/1.0/tokens/
Expand
Code Block
languagejs
titleResponse
[
  {
    "uuid": "d0ea6653-05e2-4d51-9d89-665cdfe86be6",
    "name": "readOnly",
    "read": true,
    "change": false
  },
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "read and write",
    "read": true,
    "change": true
  }
]

 

Create Token

Returns full details of the requested token, including assigned UUID.

POST /rest/agent/1.0/tokens
Expand
titleClick here to expand to see request...
Code Block
languagejs
titleResponse
  {
    "name": "informational name",
    "read": true,
    "change": false
  }

Note: Response mirrors request but includes the UUID.

Expand
titleClick here to expand response...
Code Block
languagejs
titleResponse
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "informational name",
    "read": true,
    "change": false
  }

Update Token

Alter the name, or permissions of an existing token.

PUT /rest/agent/1.0/tokens/{tokenId}
Expand
titleClick here to expand to see request...
Code Block
languagejs
titleResponse
  {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }

Note: Response mirrors request 

Expand
titleClick here to expand response...
Code Block
languagejs
titleResponse
 {
    "uuid": "7ba167aa-631c-4771-b197-fcb459cc7fd7",
    "name": "give me more power",
    "read": true,
    "change": true
  }