Credentials
Create Credential
v6 |
v7 |
POST
/v6/credentials/new |
POST
/v7/credentials |
Request
Body |
|
{ "name": "new_api_credential", "value": "secret p@ssword" } |
{ "name": "Example
Credential 1", "value": "Example
Credential 1 Password" } |
Response
Body |
|
{ "credentials": [ { "credentialId": 405, "name": "Example
Credential 1", } ] } |
{ "id": "405", "name": "Example
Credential", } |
Comments: 1. The
URL has changed. 2. The
format of the response body has changed; a single object is returned, instead
of a list of objects. 3. The
name of the `credentialId` field has changed to
`id`, and its data type has changed from integer to string. |
Get Credential
v6 |
v7 |
GET
/v6/credentials/{credentialId} |
GET
/v7/credentials/{id} |
Response
Body |
|
{ "credentials": [ {
"credentialId":
405,
"name": "Example Credential 1", "value": "Foobarbaxqux" } ] } |
{ "id": "405",
"name": "Example Credential 1",
"value": "Foobarbaxqux" } |
Comments: 1. The
format of the response body has changed; a single object is returned, instead
of a list of objects. 2. The
name of the `credentialId` field has changed to
`id`, and its data type has changed from integer to string. |
List Credentials
v6 |
v7 |
GET
/v6/credentials |
GET
/v7/credentials |
Response
Body |
|
{
"credentials": [ {
"credentialId":
405,
"name": "Example Credential 1",
"value": "Foobarbazqux" }, {
"credentialId":
406,
"name": "Example Credential 2",
"value": " Examplecredentialvalue" } ] } |
{
"credentials": [ {
"id": "405",
"name": "Example Credential 1",
"value": "Foobarbazqux" }, {
"id": "406",
"name": "Example Credential 2",
"value": "Examplecredentialvalue" } ] } |
Comments: 1. The
name of the `credentialId` field has changed to
`id`, and its data type has changed from integer to string. |
Update Credential
v6 |
v7 |
POST /v6/credentials/{credentialId}/update |
PUT /v7/credentials/{id} |
Request
Body |
|
{ "name":
"updated name"
"value": "updated password" } |
{
"name": "updated name",
"value": "updated password" } |
Response
Body |
|
{ "credentials": [ {
"credentialId":
405,
"name": "Example Credential 1" } ] } |
{ "id": "405",
"name": "Example Credential 1" } |
Comments: 1. The
request method and URL has changed. 2. The
format of the response body has changed; a single object is returned, instead
of a list of objects. 3. The
name of the `credentialId` field has changed to
`id`, and its data type has changed from integer to string. |
Delete Credential
v6 |
v7 |
POST /v6/credentials/{credentialId}/delete |
DELETE /credentials/{id} |
Comments: 1. The
request method and URL has changed. |