Blueprint (Deprecated)

This is the API for the former Blueprints service.

⚠️ Deprecation Notice: The following APIs will soon be deprecated. Use Blueprints API instead.

Get list of Blueprints for the group

Return list of Blueprint instances for the group.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

query Parameters
without_details
boolean
Responses
200

Blueprint detail

default

Unexpected error

get/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/
Request samples
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create a Blueprint

Returns the created Blueprint instance.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

query Parameters
without_details
boolean
Request Body schema: application/json
required
name
string
description
string
locked
boolean
group
string <uuid>
object (Blueprint)
Responses
201

Created

400

Blueprint create error

401

Blueprint create error

post/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get Blueprint detail

Returns the details of a Blueprint instance.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

blueprint_id
required
string <uuid>

Blueprint ID

query Parameters
without_details
boolean
Responses
200

Blueprint detail

default

Unexpected error

get/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Partial update a Blueprint

Returns the details of the updated Blueprint instance.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

blueprint_id
required
string <uuid>

Blueprint ID

query Parameters
without_details
boolean
Request Body schema: application/json
required
name
string
description
string
locked
boolean
group
string <uuid>
object (Blueprint)
Responses
200

Partially updated Blueprint

400

Blueprint update error

401

Blueprint update error

patch/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Delete a Blueprint

Deletes the requested Blueprint instance.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

blueprint_id
required
string <uuid>

Blueprint ID

query Parameters
without_details
boolean
Responses
204

Deleted Blueprint

401

Blueprint delete error

delete/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/
Request samples
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Get list of Blueprint Revisions

Returns a list of Blueprint Revisions instances for the given Blueprint.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

blueprint_id
required
string <uuid>

Blueprint ID

query Parameters
without_details
boolean
Responses
200

Blueprint revision list

default

Unexpected error

get/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/
Request samples
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get Blueprint Revision detail

Returns the detail of Blueprint Revision instance.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

blueprint_id
required
string <uuid>

Blueprint ID

revision_id
required
string <uuid>

Blueprint Revision ID

query Parameters
without_details
boolean
Responses
200

Blueprint revision detail

default

Unexpected error

get/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "revision": "string",
  • "created_by": "string",
  • "current": true,
  • "type": "Independent",
  • "comments": "string",
  • "locked": true,
  • "connectivity": {
    },
  • "sound": {
    },
  • "display_branding": {
    },
  • "hardware_settings": {
    },
  • "date_time": {
    },
  • "settings_app": {
    },
  • "system_updates": {
    },
  • "google_services": {
    },
  • "security": {
    },
  • "application": {
    },
  • "content": {
    },
  • "created_on": "2019-08-24T14:15:22Z"
}

Restore a Blueprint

Returns the Blueprint instance restored to the requested Blueprint Revision.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

Request Body schema: application/json
required
revision_id
string <uuid>
Responses
201

Restored

400

Blueprint restore error

401

Blueprint restore error

post/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/
Request samples
application/json
{
  • "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Upload a Blueprint

Create a Blueprint by uploading a json file.

⚠️ Deprecation Notice: This endpoint will soon be deprecated. Use Blueprints API instead.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

group_id
required
string <uuid>

Device Group ID

Request Body schema: multipart/form-data
required
file
string <binary>
Responses
201

Uploaded

400

Blueprint upload error

401

Blueprint upload error

post/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "locked": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "latest_revision": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}