Get a system blueprint structure

GET 
/v1/blueprints/system/:identifier/structure

Returns the Port-owned base structure of a system blueprint, meaning the fields managed by Port that users cannot modify or delete. Useful for inspecting protected fields, or as the first step when updating a system blueprint via PUT.

Updating with PUT (full replace)

The PUT body must contain all Port-managed fields, otherwise the request fails with protected_blueprint_violation. The flow:

1. Fetch the structure with this endpoint.
2. Merge your extensions on top.
3. Send the result to Change a blueprint.

Common in client-side flows like Terraform.

Updating with PATCH (partial)

For additive changes, send your delta to Update a blueprint. The server merges it onto the current blueprint, so this endpoint is not required first.

To learn more about system blueprints, check out the documentation.

Request

Responses

200

Retrieved successfully.

401

Default Response

404

A resource with the provided identifier was not found