data-credentials

data-credentials is the resource representing a credential

Download specification

Gets a credential by ID (or by name when bycredentialname=true is set in query)

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalmanage

Query Parameters

  • byCredentialNameboolean

    If set to true, credentialId in the query will be intepreted as credential's name

Path Parameters

  • qIDstring
    Required

    Credential ID

Responses

200

application/json

Credential retrieved

  • qIDstring
    Required

    UUID of the credential

  • linksobject
    Show links properties
    • selfobject
      Required

      Link to cirrent query

      Show self properties
      • hrefstring
        Required

        URL pointing to the resource

  • qNamestring
    Required

    Name of the credential

  • qTypestring
    Required

    Type of credential

  • qConnCountinteger
    Required

    Number of linked connections

  • datasourceIDstring

    ID datasource that the credential is created for

  • qReferenceKeystring

    Reference key of credential in redis

400

application/json

Empty value not permitted for dataName

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

404

application/json

Credential not found

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

GET /v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-credentials/{qID}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

{
  "qID": "065f977e-6eca-408c-b78b-ecded823712c",
  "links": {
    "self": {
      "href": "https://mytenant.us.qlik-stage.com/..."
    }
  },
  "qName": "MyCredential for REST datasource",
  "qType": "QvWebStorageProviderConnectorPackage.exe",
  "qConnCount": 1,
  "datasourceID": "rest",
  "qReferenceKey": "credential:key"
}

Patches a credential specified by ID (or by name when bycredentialname=true is set in query)

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalmanage

Query Parameters

  • byCredentialNameboolean

    If set to true, credentialId in the query will be intepreted as credential's name

Path Parameters

  • qIDstring
    Required

    Credential ID

Request Body

Required

application/json

  • patchDataarray of objects
    Required
    Show patchData properties
    • opstring

      Operation type

      Can be one of: "add""replace""remove"

    • pathstring

      Path to the target field to be patched

    • valuestring

      The value used for the patch, only needed for 'add' or 'replace'. Value type could be either string or integer, should match with the type of the target field

Responses

204

Credential updated successfully

400

application/json

Connection ID changed

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

404

application/json

Credential not found

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

409

application/json

Credential already exists (when updated name conflicts with existing record)

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

PATCH /v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"patchData":[{"op":"add","path":"/qName","value":"New value"}]}'
const https = require('https')
  const data = JSON.stringify({"patchData":[{"op":"add","path":"/qName","value":"New value"}]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-credentials/{qID}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "patchData": [
    {
      "op": "add",
      "path": "/qName",
      "value": "New value"
    }
  ]
}

Updates a credential specified by ID (or by name when bycredentialname=true is set in query)

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalmanage

Query Parameters

  • byCredentialNameboolean

    If set to true, credentialId in the query will be intepreted as credential's name

Path Parameters

  • qIDstring
    Required

    Credential ID

Request Body

Required

application/json

Credential

  • qIDstring

    UUID of the credential

  • qNamestring
    Required

    Name of the credential

  • qTypestring
    Required

    Type of credential (i.e. connector provider of the corresponding connection)

  • qPasswordstring
    Required

    Password

  • qUsernamestring
    Required

    User name

  • connectionIdstring

    ID of connection that will be associated with the credential

  • datasourceIDstring

    ID datasource that the credential is created for

Responses

204

Credential updated successfully

400

application/json

Connection ID changed

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

404

application/json

Credential not found

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

409

application/json

Credential already exists (when updated name conflicts with existing record)

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

PUT /v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"qID":"c2dd20e3-1842-42d0-81fe-1ecf08e6abde","qName":"MyCredential for REST datasource","qType":"QvWebStorageProviderConnectorPackage.exe","qPassword":"MyPassword","qUsername":"MyUsername","connectionId":"2eb98dea-5e3b-4f50-9967-841cec04b72f","datasourceID":"rest"}'
const https = require('https')
  const data = JSON.stringify({"qID":"c2dd20e3-1842-42d0-81fe-1ecf08e6abde","qName":"MyCredential for REST datasource","qType":"QvWebStorageProviderConnectorPackage.exe","qPassword":"MyPassword","qUsername":"MyUsername","connectionId":"2eb98dea-5e3b-4f50-9967-841cec04b72f","datasourceID":"rest"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-credentials/{qID}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "qID": "c2dd20e3-1842-42d0-81fe-1ecf08e6abde",
  "qName": "MyCredential for REST datasource",
  "qType": "QvWebStorageProviderConnectorPackage.exe",
  "qPassword": "MyPassword",
  "qUsername": "MyUsername",
  "connectionId": "2eb98dea-5e3b-4f50-9967-841cec04b72f",
  "datasourceID": "rest"
}

Deletes the specified credential by ID (or by name when type=credentialname is set in query)

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalmanage

Query Parameters

  • byCredentialNameboolean

    If set to true, credentialId in the query will be intepreted as credential's name

Path Parameters

  • qIDstring
    Required

    Credential ID

Responses

204

Credential deleted successfully

404

application/json

Credential not found

  • errorsarray of objects
    Show errors properties
    • codestring

      Unique internal error code

    • titlestring

      A summary in english explaining what went wrong

    • detailstring

      More concrete details

    • statusinteger

      HTTP status code

DELETE /v1/data-credentials/{qID}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-credentials/{qID}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-credentials/{qID}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli