solarOSsolarOS Docs

Lookup a solarOS resource by External Reference

Resolves one tenant-owned External Reference tuple to the matching solarOS resourceType and resourceId. Missing or cross-tenant matches return 404. Required scope: external_references:read.

GET
/external-references/lookup

Resolves one tenant-owned External Reference tuple to the matching solarOS resourceType and resourceId. Missing or cross-tenant matches return 404. Required scope: external_references:read.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Query Parameters

externalSystem*string

External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.

externalObject*string

External Reference object filter. Supply with externalSystem and externalId.

externalId*string

External Reference id filter. Supply with externalSystem and externalObject.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/external-references/lookup?externalSystem=string&externalObject=string&externalId=string"
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}