Check Credential

Proves that your credential is accepted for a site. The call writes nothing and returns no site data, so it is safe to run as often as you like: from an integration's connection test, or by hand when you set a credential up.

The request needs the same credential and scope as the upload endpoints, and no request body. A credential that can call this endpoint can upload to the same site.

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Path Parameters:

siteIdstringRequired

The unique identifier of the site.

Response Fields:

credentialAcceptedboolean

Always true on a 200. A refused credential never reaches this body.

siteIdstring

The site the credential was checked against.

Refusals:

A missing or invalid token, a token without the write scope, and a token that does not cover the site all answer 403 Forbidden with no body, as every endpoint on this API does.

Request
POST
{siteId}/credential-checks
curl -X POST \ 'https://rest.rulerapi.com/v1/{siteId}/credential-checks' \ -H 'Authorization: Bearer {your-access-token}'
Response
200 OK { "credentialAccepted": true, "siteId": "{siteId}" }