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.
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.
Lookup a solarOS resource by External Reference. Use an organization API key with external_references:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| externalSystemrequired | query | string | External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup. |
| externalObjectrequired | query | string | External Reference object filter. Supply with externalSystem and externalId. |
| externalIdrequired | query | string | External Reference id filter. Supply with externalSystem and externalObject. |
Request body
This endpoint does not accept a JSON request body.
Responses
External Reference lookup envelope
#/components/schemas/OrgApiResourceEnvelope
Missing or invalid lookup tuple
#/components/schemas/OrgApiError
Missing or invalid organization API key
#/components/schemas/OrgApiError
Organization billing access or an endpoint-specific business quota denied the request
#/components/schemas/OrgApiError
Missing required scope: external_references:read
#/components/schemas/OrgApiError
External Reference not found
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
Static examples
curl -X GET "$SOLAROS_BASE_URL/api/v1/external-references/lookup" \ -H "Authorization: Bearer $SOLAROS_API_KEY"