Pull the Provider inventory from the vendors

POST /v1/platform/inventory/sync

Calls the list endpoints of each named Provider, or of every Provider when none is named, with the Provider's active platform credential, and stores what they list: new items are added, changed names and attributes updated, and items no longer listed marked with missing_since; nothing is deleted. A Provider that fails is reported in its own error and changes nothing; dependency_unavailable answers when no named Provider could be reached. The Audit event records the counts per Provider. No vendor is called on the Call path.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/platform/inventory/sync" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/inventory/sync`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/platform/inventory/sync",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: InventorySyncRequest.

Responses

Fields of the 200 answer

The shape is InventorySyncResult.