Blueprints API

Retrieve all blueprints

Retrieve all blueprints

Request
query Parameters
ordering
string

Order the results by a specific field (-field for descending order), Combine Multiple with , like -created_at,-updated_at.

name
string

Filter the results by name, case insensitive

name_exact
string

Filter the results by name, case sensitive and matches exact name

settings__android__app_id
string <uuid>

List the blueprints which have given app_id in any of the versions for android apps.

settings__android__app_version_id
string <uuid>

List the blueprints which have given app_version_id in any of the versions for android apps.

settings__ios__app_id
string <uuid>

List the blueprints which have given app_id in any of the versions for ios apps.

settings__ios__app_version_id
string <uuid>

List the blueprints which have given app_version_id in any of the versions for ios apps.

settings__android__file_id
string <uuid>

List the blueprints which have given file_id in any of the versions.

settings__android__wifi_network_id
string <uuid>

List the blueprints which have given wifi_network_id in any of the versions.

Responses
200

Success

get/v2/blueprints/
Request samples
Response samples
application/json
{
  • "content": {
    }
}

Create a new blueprint

Create a new blueprint

Request
Request Body schema: application/json
name
string

Name of the blueprint

description
string

Description of the blueprint

comments
string

Comments on the blueprint

object (settingsV2)
Responses
201

Success

400

Bad Request

post/v2/blueprints/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "comments": "string",
  • "settings": {
    }
}
Response samples
application/json
{
  • "content": {
    },
  • "message": "string",
  • "code": 201
}

Retrieve a blueprint by ID

Retrieve a blueprint by ID

Request
path Parameters
blueprint_id
required
string <uuid>
Responses
200

Success

404

Content not found

get/v2/blueprints/{blueprint_id}/
Request samples
Response samples
application/json
{
  • "content": {
    },
  • "message": "string",
  • "code": 201
}

Update a blueprint by ID

Update a blueprint by ID

Request
path Parameters
blueprint_id
required
string <uuid>
Request Body schema: application/json
required
name
string

Name of the blueprint

description
string

Description of the blueprint

comments
string

Comments on the blueprint

object (settingsV2)
Responses
200

Success

400

Bad Request

404

Resource not found

put/v2/blueprints/{blueprint_id}/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "comments": "string",
  • "settings": {
    },
  • "publish": true
}
Response samples
application/json
{
  • "content": {
    },
  • "message": "string",
  • "code": 201
}

Delete a blueprint by ID

Delete a blueprint by ID

Request
path Parameters
blueprint_id
required
string <uuid>
Responses
204

Success

404

Resource not found

delete/v2/blueprints/{blueprint_id}/
Request samples
Response samples
application/json
{
  • "content": {
    },
  • "message": "string",
  • "code": 201
}

Retrieve all versions of a blueprint

Retrieve all versions of a blueprint

Request
path Parameters
blueprint_id
required
string <uuid>
query Parameters
ordering
string

Order the results by a specific field (-field for descending order), Combine Multiple with , like -version_number,-minor_version_number.

version_number
string

Filter the results by version_number

publish
string

Filter the results by publish

settings__android__app_id
string <uuid>

List the versions which have given app_id.

settings__android__app_version_id
string <uuid>

List the versions which have given app_version_id.

settings__android__file_id
string <uuid>

List the blueprints which have given file_id.

settings__android__wifi_network_id
string <uuid>

List the blueprints which have given wifi_network_id.

Responses
200

Success

get/v2/blueprints/{blueprint_id}/versions/
Request samples
Response samples
application/json
{
  • "content": {
    }
}

Retrieve a specific version of the blueprint

Retrieve a specific version of the blueprint

Request
path Parameters
blueprint_id
required
string <uuid>
version_id
required
string <uuid>
Responses
200

Success

404

Resouce not found

get/v2/blueprints/{blueprint_id}/versions/{version_id}/
Request samples
Response samples
application/json
{
  • "content": {
    },
  • "message": "string",
  • "code": 201
}