deployments

GET /api/deployments/

Changed on

View for individual users to report/retrieve available deployments.

Request

  • Base URL
    https://app.pixiebrix.com
  • Auth
    none declared

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

platformsstring

Comma-separated or repeated platform names. Defaults to 'webextension'.

Response

idstring uuid
namestring required
activeboolean
options_configobject
created_atstring date-time
updated_atstring date-time
package_versionstring required
platform_namesstring[]
userstring

Changes

    • info

      the response property //// became required for the status (media type: application/json; version=1.1)

    • info

      the response property //// became required for the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • breaking

      the response property /// became nullable for the status (media type: application/json; version=1.1)

    • breaking

      the response property /// became nullable for the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • breaking

      the response property /// became nullable for the status (media type: application/json; version=1.1)

    • breaking

      the response property /// became nullable for the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • breaking

      the response property /// became optional for the status (media type: application/json; version=1.1)

    • breaking

      the response property /// became optional for the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • breaking

      removed the required property // from the response with the status (media type: application/json; version=1.1)

    • breaking

      removed the required property // from the response with the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • warning

      removed the optional property // from the response with the status (media type: application/json; version=1.1)

    • warning

      removed the optional property // from the response with the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • info

      api operation id listUserDeploymentDetails removed and replaced with listUserHeartbeats

    • info

      the query request parameter platforms became optional

    • info

      media type application/json; version=2.0 was changed to application/json; version=1.1 for the response status

    • info

      media type application/vnd.pixiebrix.api+json; version=2.0 was changed to application/vnd.pixiebrix.api+json; version=1.1 for the response status

    • info

      added the optional property /// to the response with the status (media type: application/json; version=1.1)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • info

      added the optional property /// to the response with the status (media type: application/json; version=1.1)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • info

      added the optional write-only property items/user to the response with the status (media type: application/json; version=1.1)

    • info

      added the optional write-only property items/user to the response with the status (media type: application/vnd.pixiebrix.api+json; version=1.1)

    • info

      the response write-only property items/platform_names became optional for the status (media type: application/json; version=1.1)

    • info

      the response write-only property items/platform_names became optional for the status (media type: application/vnd.pixiebrix.api+json; version=1.1)