NFnforgeio
datasources

Update an existing data source.

Similar to creating a data source, password and basicAuthPassword should be defined under secureJsonData in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under secureJsonFields section in the response.

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: datasources:write and scopes: datasources:*, datasources:uid:* and datasources:uid:1 (single data source).

put/datasources/uid/{uid}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/datasources/uid/{uid}
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

uidstring required

Request body

accessstring
basicAuthboolean
basicAuthUserstring
databasestring
isDefaultboolean
jsonDataJson
namestring
secureJsonDataobject
typestring
uidstring
urlstring
userstring
versioninteger
withCredentialsboolean

Response

(empty)

idinteger required

ID Identifier of the new data source.

messagestring required

Message Message of the deleted dashboard.

namestring required

Name of the new data source.

Example response

{
  "id": 65,
  "message": "Data source added",
  "name": "My Data source"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.