Endpoints
Skip to section| GET | /v1/data-credentials/{qID} |
| PATCH | /v1/data-credentials/{qID} |
| PUT | /v1/data-credentials/{qID} |
| DELETE | /v1/data-credentials/{qID} |
Gets a credential by ID (or by name when bycredentialname=true is set in query)
Facts GET /v1/data-credentials/{qID}
Rate limit required | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/data-credentials/{qID}
qID required | Credential ID |
Query Parameters GET /v1/data-credentials/{qID}
byCredentialName | If set to true, credentialId in the query will be intepreted as credential's name |
Responses GET /v1/data-credentials/{qID}
200 application/json | Credential retrieved |
400 application/json | Empty value not permitted for dataName |
404 application/json | Credential not found |
GET/v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-H "Authorization: Bearer <API-key>"Response GET /v1/data-credentials/{qID}
{
"qID": "string",
"links": {
"self": {
"href": "string"
}
},
"qName": "string",
"qType": "string",
"qConnCount": 0,
"qReferenceKey": "string"
}Patches a credential specified by ID (or by name when bycredentialname=true is set in query)
Facts PATCH /v1/data-credentials/{qID}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/data-credentials/{qID}
qID required | Credential ID |
Query Parameters PATCH /v1/data-credentials/{qID}
byCredentialName | If set to true, credentialId in the query will be intepreted as credential's name |
Request Body PATCH /v1/data-credentials/{qID}
application/json | No description |
Responses PATCH /v1/data-credentials/{qID}
204 object | Credential updated successfully |
400 application/json | Connection ID changed |
404 application/json | Credential not found |
409 application/json | Credential already exists (when updated name conflicts with existing record) |
PATCH/v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X PATCH \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"patchData":[{"op":"add","path":"Use '/qName' to patch the field 'qName' on toplevel, use '/tags/<index_number>' to patch an item in array properties like 'tags'","value":"string"}]}'Request PATCH /v1/data-credentials/{qID}
{
"patchData": [
{
"op": "add",
"path": "Use '/qName' to patch the field 'qName' on toplevel, use '/tags/<index_number>' to patch an item in array properties like 'tags'",
"value": "string"
}
]
}Updates a credential specified by ID (or by name when bycredentialname=true is set in query)
Facts PUT /v1/data-credentials/{qID}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters PUT /v1/data-credentials/{qID}
qID required | Credential ID |
Query Parameters PUT /v1/data-credentials/{qID}
byCredentialName | If set to true, credentialId in the query will be intepreted as credential's name |
Request Body PUT /v1/data-credentials/{qID}
application/json | No description |
Responses PUT /v1/data-credentials/{qID}
204 object | Credential updated successfully |
400 application/json | Connection ID changed |
404 application/json | Credential not found |
409 application/json | Credential already exists (when updated name conflicts with existing record) |
PUT/v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"qID":"string","qName":"string","qType":"string","qPassword":"string","qUsername":"string","connectionId":"string","datasourceID":"string"}'Request PUT /v1/data-credentials/{qID}
{
"qID": "string",
"qName": "string",
"qType": "string",
"qPassword": "string",
"qUsername": "string",
"connectionId": "string",
"datasourceID": "string"
}Deletes the specified credential by ID (or by name when type=credentialname is set in query)
Facts DELETE /v1/data-credentials/{qID}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/data-credentials/{qID}
qID required | Credential ID |
Query Parameters DELETE /v1/data-credentials/{qID}
byCredentialName | If set to true, credentialId in the query will be intepreted as credential's name |
Responses DELETE /v1/data-credentials/{qID}
204 object | Credential deleted successfully |
404 application/json | Credential not found |
DELETE/v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"bycredentialname
booleanIf set to true, credentialId in the query will be intepreted as credential's name
qCredID
stringCredential ID
Credential
objectProperties
qID required string | UUID of the credential |
links | No description |
qName required string | Name of the credential |
qType required string | Type of credential |
qConnCount required integer | Number of linked connections |
qReferenceKey string | Reference key of credential in redis |
CredentialCreate
Credential
Properties
qID string | UUID of the credential |
qName required string | UName of the credential |
qType required string | Type of credential |
qPassword required string | Password |
qUsername required string | User name |
connectionId string | ID of connection that will be associated with the credential |
datasourceID string | ID datasource that the credential is created for |
Error
objectProperties
code string | Unique internal error code |
title string | A summary in english explaining what went wrong |
detail string | More concrete details |
status integer | HTTP status code |
Errors
Array<Error>Properties
code string | Unique internal error code |
title string | A summary in english explaining what went wrong |
detail string | More concrete details |
status integer | HTTP status code |
Link
objectProperties
self required object | Link to cirrent query |
PatchRequest
objectProperties
patchData required | No description |
ResponseErrors
objectProperties
errors | No description |
