OPopal
resources

Get the ID of the configuration template linked to a resource

Changed on

Returns the ID of the configuration template that the resource is currently linked to. The response body is {"configuration_template_id": "<uuid>" | null}:

  • <uuid> is the ID of the configuration template the resource is linked to.
  • null means the resource is not linked to any configuration template and uses its own private configuration.

This endpoint only exposes the link between a resource and a configuration template — it does not return the template's own fields (name, description, request configurations, visibility, etc.). To read those, call GET /configuration-templates/{configuration_template_id} with the ID returned here.

get/resources/{resource_id}/configuration-template

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

resource_idstring uuid required

The ID of the resource whose configuration template link is being read.

Response

The ID of the configuration template currently linked to the resource, or null if the resource uses its own private configuration.

configuration_template_idstring uuid nullable required

The ID of the configuration template that the resource is linked to, or null if the resource is not linked to a configuration template. Only the ID is exposed here; the template's own fields are managed through the /configuration-templates endpoints.

Example response

{
  "configuration_template_id": "06851574-e50d-40ca-8c78-f72ae6ab4304"
}

Changes