Sync all Custom Resources

To send data of custom resource that you want to build custom tests on, use CustomResource.

This call replaces ALL existing CustomResource resources for the given app and source_id - this is a “state of the world” sync. In other words, if a CustomResource resource is sent for a user in a previous sync_all call, but is not included in a later sync_all call for that customer, it is assumed to no longer exist and is deleted in Vanta.

** Headers **

Authorization: Bearer <access_token>

** Scopes **

connectors.self:write-resource

** Schema **

Expand the resources array below for the schema of CustomResource.

PUT /v1/resources/custom_resource

Sync all Custom Resources

cURL

curl --request PUT \
  --url https://api.vanta.com/v1/resources/custom_resource \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceId": "<string>",
  "resources": [
    {
      "displayName": "<string>",
      "uniqueId": "<string>",
      "externalUrl": "<string>"
    }
  ]
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

List of resources to sync

resourceId · string · required

Vanta generated identifier for the given resource, and can be found on the developer console page. See the list of registered resources and their IDs on https://app.vanta.com/settings/developer-console/<app_id>?tab=resources

resources · object[] · required

Show child attributes

Response

200 - application/json

The current resources synced.

success · boolean · required