{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "microvisor.v1.account_config": { "type": "object", "properties": { "key": { "type": "string", "nullable": true, "description": "The config key; up to 100 characters." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "value": { "type": "string", "nullable": true, "description": "The config value; up to 4096 characters." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Config." } } }, "microvisor.v1.account_secret": { "type": "object", "properties": { "key": { "type": "string", "nullable": true, "description": "The secret key; up to 100 characters." }, "date_rotated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Secret." } } }, "microvisor.v1.app": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KA[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34-character string that uniquely identifies this App." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account." }, "hash": { "type": "string", "nullable": true, "description": "App manifest hash represented as `hash_algorithm:hash_value`." }, "unique_name": { "type": "string", "nullable": true, "description": "A developer-defined string that uniquely identifies the App. This value must be unique for all Apps on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this App was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this App was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "microvisor.v1.app.app_manifest": { "type": "object", "properties": { "app_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KA[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34-character string that uniquely identifies this App." }, "hash": { "type": "string", "nullable": true, "description": "App manifest hash represented as `hash_algorithm:hash_value`." }, "encoded_bytes": { "type": "string", "nullable": true, "description": "The base-64 encoded manifest" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of this Manifest." } } }, "microvisor.v1.device": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^UV[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34-character string that uniquely identifies this Device." }, "unique_name": { "type": "string", "nullable": true, "description": "A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The `unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account." }, "app": { "type": "object", "nullable": true, "description": "Information about the target App and the App reported by this Device. Contains the properties `target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`." }, "logging": { "type": "object", "nullable": true, "description": "Object specifying whether application logging is enabled for this Device. Contains the properties `enabled` and `date_expires`." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Device was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Device was last updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The absolute URLs of related resources." } } }, "microvisor.v1.device.device_config": { "type": "object", "properties": { "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^UV[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34-character string that uniquely identifies the parent Device." }, "key": { "type": "string", "nullable": true, "description": "The config key; up to 100 characters." }, "value": { "type": "string", "nullable": true, "description": "The config value; up to 4096 characters." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Config." } } }, "microvisor.v1.device.device_secret": { "type": "object", "properties": { "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^UV[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34-character string that uniquely identifies the parent Device." }, "key": { "type": "string", "nullable": true, "description": "The secret key; up to 100 characters." }, "date_rotated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the Secret." } } } } }, "info": { "title": "Twilio - Microvisor", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "openapi": "3.0.1", "paths": { "/v1/Configs": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "account_configs", "pathType": "list" }, "get": { "description": "Retrieve a list of all Configs for an Account.", "summary": "Retrieve a list of all Configs for an Account.", "tags": [ "MicrovisorV1AccountConfig" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configs": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.account_config" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListAccountConfigResponse" }, "examples": { "readEmpty": { "value": { "configs": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", "next_page_url": null, "key": "configs" } } }, "readFull": { "value": { "configs": [ { "key": "first", "value": "something", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Configs/first" }, { "key": "second", "value": "or other", "date_updated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Configs/second" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Configs?PageSize=50&Page=0", "next_page_url": null, "key": "configs" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAccountConfig" }, "post": { "description": "Create a config for an Account.", "summary": "Create a config for an Account.", "tags": [ "MicrovisorV1AccountConfig" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" }, "examples": { "createAccountConfig": { "value": { "key": "first", "value": "place", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateAccountConfig", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateAccountConfigRequest", "properties": { "Key": { "type": "string", "description": "The config key; up to 100 characters." }, "Value": { "type": "string", "description": "The config value; up to 4096 characters." } }, "required": [ "Key", "Value" ] }, "examples": { "createAccountConfig": { "value": { "Key": "first,", "Value": "first val" } } } } } } } }, "/v1/Configs/{Key}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "account_configs", "pathType": "instance" }, "get": { "description": "Retrieve a Config for an Account.", "summary": "Retrieve a Config for an Account.", "tags": [ "MicrovisorV1AccountConfig" ], "parameters": [ { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" }, "examples": { "fetch": { "value": { "key": "first", "value": "place", "date_updated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAccountConfig" }, "post": { "description": "Update a config for an Account.", "summary": "Update a config for an Account.", "tags": [ "MicrovisorV1AccountConfig" ], "parameters": [ { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_config" }, "examples": { "update": { "value": { "key": "first", "value": "place", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateAccountConfig", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateAccountConfigRequest", "properties": { "Value": { "type": "string", "description": "The config value; up to 4096 characters." } }, "required": [ "Value" ] }, "examples": { "update": { "value": { "Value": "place" } } } } } } }, "delete": { "description": "Delete a config for an Account.", "summary": "Delete a config for an Account.", "tags": [ "MicrovisorV1AccountConfig" ], "parameters": [ { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteAccountConfig" } }, "/v1/Secrets": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "account_secrets", "pathType": "list" }, "get": { "description": "Retrieve a list of all Secrets for an Account.", "summary": "Retrieve a list of all Secrets for an Account.", "tags": [ "MicrovisorV1AccountSecret" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "secrets": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.account_secret" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListAccountSecretResponse" }, "examples": { "readEmpty": { "value": { "secrets": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", "next_page_url": null, "key": "secrets" } } }, "readFull": { "value": { "secrets": [ { "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Secrets/first" }, { "key": "second", "date_rotated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Secrets/second" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Secrets?PageSize=50&Page=0", "next_page_url": null, "key": "secrets" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAccountSecret" }, "post": { "description": "Create a secret for an Account.", "summary": "Create a secret for an Account.", "tags": [ "MicrovisorV1AccountSecret" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" }, "examples": { "createAccountSecret": { "value": { "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateAccountSecret", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateAccountSecretRequest", "properties": { "Key": { "type": "string", "description": "The secret key; up to 100 characters." }, "Value": { "type": "string", "description": "The secret value; up to 4096 characters." } }, "required": [ "Key", "Value" ] }, "examples": { "createAccountSecret": { "value": { "Key": "first,", "Value": "first val" } } } } } } } }, "/v1/Secrets/{Key}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "account_secrets", "pathType": "instance" }, "get": { "description": "Retrieve a Secret for an Account.", "summary": "Retrieve a Secret for an Account.", "tags": [ "MicrovisorV1AccountSecret" ], "parameters": [ { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" }, "examples": { "fetch": { "value": { "key": "first", "date_rotated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAccountSecret" }, "post": { "description": "Update a secret for an Account.", "summary": "Update a secret for an Account.", "tags": [ "MicrovisorV1AccountSecret" ], "parameters": [ { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.account_secret" }, "examples": { "update": { "value": { "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateAccountSecret", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateAccountSecretRequest", "properties": { "Value": { "type": "string", "description": "The secret value; up to 4096 characters." } }, "required": [ "Value" ] }, "examples": { "update": { "value": { "Value": "place" } } } } } } }, "delete": { "description": "Delete a secret for an Account.", "summary": "Delete a secret for an Account.", "tags": [ "MicrovisorV1AccountSecret" ], "parameters": [ { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteAccountSecret" } }, "/v1/Apps": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], "dependentProperties": { "app_manifests": { "mapping": { "app_sid": "sid" }, "resource_url": "/v1/Apps/{app_sid}/Manifest" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of all Apps for an Account.", "summary": "Retrieve a list of all Apps for an Account.", "tags": [ "MicrovisorV1App" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.app" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListAppResponse" }, "examples": { "readEmpty": { "value": { "apps": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", "next_page_url": null, "key": "apps" } } }, "readFull": { "value": { "apps": [ { "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "hash": "hash", "unique_name": "unique name", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Apps?PageSize=50&Page=0", "next_page_url": null, "key": "apps" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListApp" } }, "/v1/Apps/{Sid}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], "dependentProperties": { "app_manifests": { "mapping": { "app_sid": "sid" }, "resource_url": "/v1/Apps/{app_sid}/Manifest" } }, "pathType": "instance" }, "get": { "description": "Fetch a specific App.", "summary": "Fetch a specific App.", "tags": [ "MicrovisorV1App" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34-character string that uniquely identifies this App.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app" }, "examples": { "fetch": { "value": { "sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "hash": "hash", "unique_name": "look at this crazy app", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "app_manifests": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchApp" }, "delete": { "description": "Delete a specific App.", "summary": "Delete a specific App.", "tags": [ "MicrovisorV1App" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34-character string that uniquely identifies this App.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteApp" } }, "/v1/Apps/{AppSid}/Manifest": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Apps/{Sid}", "mountName": "app_manifests", "pathType": "instance" }, "get": { "description": "Retrieve the Manifest for an App.", "summary": "Retrieve the Manifest for an App.", "tags": [ "MicrovisorV1AppManifest" ], "parameters": [ { "name": "AppSid", "in": "path", "description": "A 34-character string that uniquely identifies this App.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.app.app_manifest" }, "examples": { "fetch": { "value": { "app_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "hash": "some hash", "encoded_bytes": "some value", "url": "https://microvisor.twilio.com/v1/Apps/KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Manifest" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAppManifest" } }, "/v1/Devices": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], "dependentProperties": { "device_configs": { "mapping": { "device_sid": "sid" }, "resource_url": "/v1/Devices/{device_sid}/Configs" }, "device_secrets": { "mapping": { "device_sid": "sid" }, "resource_url": "/v1/Devices/{device_sid}/Secrets" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of all Devices registered with the Account.", "summary": "Retrieve a list of all Devices registered with the Account.", "tags": [ "MicrovisorV1Device" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.device" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDeviceResponse" }, "examples": { "readEmpty": { "value": { "devices": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", "next_page_url": null, "key": "devices" } } }, "readFull": { "value": { "devices": [ { "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "This is my device; there are many like it.", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "app": { "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "target_hash": null, "date_targeted": "2021-01-01T12:34:56Z", "update_status": "up-to-date", "update_error_code": 0, "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_reported": "2021-01-01T12:34:56Z" }, "logging": { "enabled": true, "date_expires": "2021-01-01T12:34:56Z" }, "date_created": "2021-01-01T12:34:56Z", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices?PageSize=50&Page=0", "next_page_url": null, "key": "devices" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDevice" } }, "/v1/Devices/{Sid}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], "dependentProperties": { "device_configs": { "mapping": { "device_sid": "sid" }, "resource_url": "/v1/Devices/{device_sid}/Configs" }, "device_secrets": { "mapping": { "device_sid": "sid" }, "resource_url": "/v1/Devices/{device_sid}/Secrets" } }, "pathType": "instance" }, "get": { "description": "Fetch a specific Device.", "summary": "Fetch a specific Device.", "tags": [ "MicrovisorV1Device" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34-character string that uniquely identifies this Device.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" }, "examples": { "fetch": { "value": { "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "This is my device; there are many like it.", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "app": { "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "target_hash": null, "date_targeted": "2021-01-01T12:34:56Z", "update_status": "up-to-date", "update_error_code": 0, "reported_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_reported": "2021-01-01T12:34:56Z" }, "logging": { "enabled": true, "date_expires": "2021-01-01T12:34:56Z" }, "date_created": "2021-01-01T12:34:56Z", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDevice" }, "post": { "description": "Update a specific Device.", "summary": "Update a specific Device.", "tags": [ "MicrovisorV1Device" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34-character string that uniquely identifies this Device.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device" }, "examples": { "update": { "value": { "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "UniqueName", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "app": { "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "target_hash": null, "date_targeted": "2021-01-01T12:34:56Z", "update_status": "pending", "update_error_code": 0, "reported_sid": null, "date_reported": "2021-01-01T12:34:56Z" }, "logging": { "enabled": false, "date_expires": null }, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" } } }, "restartApp": { "value": { "sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "UniqueName", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "app": { "target_sid": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "target_hash": null, "date_targeted": "2021-01-01T12:34:56Z", "update_status": "pending", "update_error_code": 0, "reported_sid": null, "date_reported": "2021-01-01T12:34:56Z" }, "logging": { "enabled": false, "date_expires": null }, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "device_configs": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs", "device_secrets": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeviceRequest", "properties": { "UniqueName": { "type": "string", "description": "A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID." }, "TargetApp": { "type": "string", "description": "The SID or unique name of the App to be targeted to the Device." }, "LoggingEnabled": { "type": "boolean", "description": "A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours." }, "RestartApp": { "type": "boolean", "description": "Set to true to restart the App running on the Device." } } }, "examples": { "update": { "value": { "UniqueName": "unique_name", "TargetApp": "KAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "LoggingEnabled": false } }, "restartApp": { "value": { "RestartApp": true } } } } } } } }, "/v1/Devices/{DeviceSid}/Configs": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Devices/{Sid}", "mountName": "device_configs", "pathType": "list" }, "get": { "description": "Retrieve a list of all Configs for a Device.", "summary": "Retrieve a list of all Configs for a Device.", "tags": [ "MicrovisorV1DeviceConfig" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configs": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDeviceConfigResponse" }, "examples": { "readEmpty": { "value": { "configs": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", "next_page_url": null, "key": "configs" } } }, "readFull": { "value": { "configs": [ { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "value": "some value", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" }, { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "second", "value": "some value", "date_updated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/second" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs?PageSize=50&Page=0", "next_page_url": null, "key": "configs" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeviceConfig" }, "post": { "description": "Create a config for a Microvisor Device.", "summary": "Create a config for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceConfig" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" }, "examples": { "createAccountConfig": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "value": "some value", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeviceConfig", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeviceConfigRequest", "properties": { "Key": { "type": "string", "description": "The config key; up to 100 characters." }, "Value": { "type": "string", "description": "The config value; up to 4096 characters." } }, "required": [ "Key", "Value" ] }, "examples": { "createAccountConfig": { "value": { "Key": "first,", "Value": "first val" } } } } } } } }, "/v1/Devices/{DeviceSid}/Configs/{Key}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Devices/{Sid}", "mountName": "device_configs", "pathType": "instance" }, "get": { "description": "Retrieve a Config for a Device.", "summary": "Retrieve a Config for a Device.", "tags": [ "MicrovisorV1DeviceConfig" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" }, "examples": { "fetch": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "value": "some value", "date_updated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeviceConfig" }, "post": { "description": "Update a config for a Microvisor Device.", "summary": "Update a config for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceConfig" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_config" }, "examples": { "update": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "value": "place", "date_updated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configs/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeviceConfig", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeviceConfigRequest", "properties": { "Value": { "type": "string", "description": "The config value; up to 4096 characters." } }, "required": [ "Value" ] }, "examples": { "update": { "value": { "Value": "place" } } } } } } }, "delete": { "description": "Delete a config for a Microvisor Device.", "summary": "Delete a config for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceConfig" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The config key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeviceConfig" } }, "/v1/Devices/{DeviceSid}/Secrets": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Devices/{Sid}", "mountName": "device_secrets", "pathType": "list" }, "get": { "description": "Retrieve a list of all Secrets for a Device.", "summary": "Retrieve a list of all Secrets for a Device.", "tags": [ "MicrovisorV1DeviceSecret" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "secrets": { "type": "array", "items": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDeviceSecretResponse" }, "examples": { "readEmpty": { "value": { "secrets": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", "next_page_url": null, "key": "secrets" } } }, "readFull": { "value": { "secrets": [ { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" }, { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "second", "date_rotated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/second" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", "previous_page_url": null, "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets?PageSize=50&Page=0", "next_page_url": null, "key": "secrets" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeviceSecret" }, "post": { "description": "Create a secret for a Microvisor Device.", "summary": "Create a secret for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceSecret" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" }, "examples": { "createAccountSecret": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeviceSecret", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeviceSecretRequest", "properties": { "Key": { "type": "string", "description": "The secret key; up to 100 characters." }, "Value": { "type": "string", "description": "The secret value; up to 4096 characters." } }, "required": [ "Key", "Value" ] }, "examples": { "createAccountSecret": { "value": { "Key": "first,", "Value": "first val" } } } } } } } }, "/v1/Devices/{DeviceSid}/Secrets/{Key}": { "servers": [ { "url": "https://microvisor.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "parent": "/Devices/{Sid}", "mountName": "device_secrets", "pathType": "instance" }, "get": { "description": "Retrieve a Secret for a Device.", "summary": "Retrieve a Secret for a Device.", "tags": [ "MicrovisorV1DeviceSecret" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" }, "examples": { "fetch": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "date_rotated": "2021-01-01T12:34:57Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeviceSecret" }, "post": { "description": "Update a secret for a Microvisor Device.", "summary": "Update a secret for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceSecret" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/microvisor.v1.device.device_secret" }, "examples": { "update": { "value": { "device_sid": "UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "key": "first", "date_rotated": "2021-01-01T12:34:56Z", "url": "https://microvisor.twilio.com/v1/Devices/UVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Secrets/first" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateDeviceSecret", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateDeviceSecretRequest", "properties": { "Value": { "type": "string", "description": "The secret value; up to 4096 characters." } }, "required": [ "Value" ] }, "examples": { "update": { "value": { "Value": "place" } } } } } } }, "delete": { "description": "Delete a secret for a Microvisor Device.", "summary": "Delete a secret for a Microvisor Device.", "tags": [ "MicrovisorV1DeviceSecret" ], "parameters": [ { "name": "DeviceSid", "in": "path", "description": "A 34-character string that uniquely identifies the Device.", "schema": { "type": "string" }, "required": true }, { "name": "Key", "in": "path", "description": "The secret key; up to 100 characters.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteDeviceSecret" } } }, "servers": [ { "url": "https://microvisor.twilio.com" } ], "tags": [ { "name": "MicrovisorV1AccountConfig" }, { "name": "MicrovisorV1AccountSecret" }, { "name": "MicrovisorV1App" }, { "name": "MicrovisorV1AppManifest" }, { "name": "MicrovisorV1DebugToken" }, { "name": "MicrovisorV1Device" }, { "name": "MicrovisorV1DeviceCert" }, { "name": "MicrovisorV1DeviceConfig" }, { "name": "MicrovisorV1DeviceSecret" }, { "name": "MicrovisorV1LoggingToken" } ], "security": [ { "accountSid_authToken": [] } ] }