API Reference

List Blueprints

get
https://api.controlup.com/v1/organizations//blueprints

Returns a paginated list of Blueprints in your organization.

Path Params
uuid
required
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your Tenant Manager (MSP) organization. You can find it on the API Key Management page in the DEX platform.

Query Params
int32
≥ 1
Defaults to 1

The page of results to return.
The first page is page number 1.

int32
≥ 1
Defaults to 10

The number of results returned per page.

string
enum

Sorts results according to the specified field.

Allowed:
string
enum

The sort order (ascending / descending) of the field specified by the _sortBy parameter.

Allowed:
string

A search filter that is applied to all fields.
Only results that contain the specified string are returned.

string
enum
Defaults to json

The format of returned results.

Allowed:
source_org_id
array of objects

Only Blueprints whose source tenant is one of these organization IDs are returned.

source_org_id
mode
array of objects

Only Blueprints with one of these deploy modes are returned.

mode
Allowed:
config_types
array of objects

Only Blueprints that include at least one of these configuration types are returned.

config_types
Allowed:
Responses

Updated about 7 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago

Did this page help you?