Fetch configured plugin

GET /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}

Headers

  • Flex-Metadata string

    The Flex-Metadata HTTP request header

Path parameters

  • ConfigurationSid string Required

    The SID of the Flex Plugin Configuration the resource to belongs to.

  • PluginSid string Required

    The unique string that we created to identify the Flex Plugin resource.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that the Flex Plugin resource is installed for.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • configuration_sid string | null

      The SID of the Flex Plugin Configuration that this Flex Plugin belongs to.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FJ[0-9a-fA-F]{32}$.

    • plugin_sid string | null

      The SID of the Flex Plugin.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FP[0-9a-fA-F]{32}$.

    • plugin_version_sid string | null

      The SID of the Flex Plugin Version.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FV[0-9a-fA-F]{32}$.

    • phase integer

      The phase this Flex Plugin would initialize at runtime.

      Default value is 0.

    • plugin_url string | null

      The URL of where the Flex Plugin Version JavaScript bundle is hosted on.

    • unique_name string | null

      The name that uniquely identifies this Flex Plugin resource.

    • friendly_name string | null

      The friendly name of this Flex Plugin resource.

    • description string | null

      A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long

    • plugin_archived boolean | null

      Whether the Flex Plugin is archived. The default value is false.

    • version string | null

      The latest version of this Flex Plugin Version.

    • changelog string | null

      A changelog that describes the changes this Flex Plugin Version brings.

    • plugin_version_archived boolean | null

      Whether the Flex Plugin Version is archived. The default value is false.

    • private boolean | null

      Whether to validate the request is authorized to access the Flex Plugin Version.

    • date_created string(date-time) | null

      The date and time in GMT when the Flex Plugin was installed specified in ISO 8601 format.

    • url string(uri) | null

      The absolute URL of the Flex Plugin resource.

GET /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}
curl \
 --request GET 'https://flex-api.twilio.com/v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}' \
 --user "username:password" \
 --header "Flex-Metadata: string"
Response examples (200)
{
  "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "phase": 3,
  "private": true,
  "version": "1.0.0",
  "changelog": "this is a changelog",
  "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "plugin_url": "https://sample.twil.io/plugin.js",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "description": "the sample plugin",
  "unique_name": "sample-plugin",
  "date_created": "2020-01-10T20:00:00Z",
  "friendly_name": "sample plugin",
  "plugin_archived": false,
  "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "plugin_version_sid": "PVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "plugin_version_archived": false
}