Blueprints API

The Blueprints API helps to manage device blueprints.

Validate Blueprint CloudGateway

POST /v3/blueprints/validate

Validates a specified blueprint.

Request

$ curl -X POST \
    http://api.enapter.com/v3/blueprints/validate \
    -F data=@my_blueprint.zip

Body

A zipped folder with Enapter blueprint.

Response

A list containing validation errors, if any occurred.

Valid blueprint

{
}

Blueprint without manifest.yml

{
    "validation_errors": ["missed file manifest.yml"]
}

Upload Blueprint CloudGateway

POST /v3/blueprints/upload

Uploads blueprint to the Enapter Platform.

Request

$ curl -X POST \
    http://api.enapter.com/v3/blueprints/upload \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -F data=@blueprint2.zip

Body

A zipped folder with Enapter blueprint.

Response

{
    "id": "cd4bd70c-ee7a-48d9-bce0-cdabae6eeeb2",
    "created_at": "2024-12-09T19:06:00.010827Z"
}

Get Blueprint CloudGateway

GET /v3/blueprints/{blueprint_id}

Returns information about a specified blueprint.

Request

$ curl http://api.enapter.com/v3/blueprints/cd4bd70c-ee7a-48d9-bce0-cdabae6eeeb2 \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}'

Response

{
    "blueprint": {
        "id": "cd4bd70c-ee7a-48d9-bce0-cdabae6eeeb2",
        "created_at": "2024-12-09T19:06:00.010827Z"
    }
}

blueprintobject

The Blueprint object contains information about the requested blueprint.

Blueprint.idstring

Blueprint ID.

Blueprint.created_atinteger

The timestamp when the blueprint was first created.

Get Blueprint as .zip archive CloudGateway

GET /v3/blueprints/{blueprint_id}/zip

Retrieves the blueprint as a .zip archive.

Request

Retrieve original blueprint

$ curl http://api.enapter.com/v3/blueprints/cd4bd70c-ee7a-48d9-bce0-cdabae6eeeb2?view=ORIGINAL -G \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}'

Query Parameters

viewstringdefault: COMPILED

The view parameter describes what version of blueprint should be returned:

• ORIGINAL - as the blueprint was uploaded to Enapter Platform.
• COMPILED - a compiled version of the blueprint.

Response

A .zip archive containing the requested view of the blueprint.

Get All Device Profiles CloudGateway

GET /v3/blueprints/download_device_profiles

Downloads all device profiles from Enapter Platform as a .zip archive.

Request

$ curl http://api.enapter.com/v3/blueprints/download_device_profiles \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}'

Response

A .zip archive containing all profiles from the Enapter platform.

Upload Device Profiles CloudGateway

POST /v3/blueprints/upload_device_profiles

Uploads specified device profile(s) to the Enapter Platform. The profile(s) then can be used in a device manifest.

Request

$ curl -X POST \
    http://api.enapter.com/v3/blueprints/upload_device_profiles \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -F data=@my_profiles.zip

Body

Profile(s) in a .zip archive which was returned from download_device_profiles.