Path parameters

• Sid string Required

  The SID of the Service resource to fetch.

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

  • sid string | null

    The unique string that we created to identify the Service resource.

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

  • unique_name string | null

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.

  • account_sid string | null

    The SID of the Account that created the Service resource.

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

  • friendly_name string | null

    The string that you assigned to describe the resource.

  • date_created string(date-time) | null

    The date and time in GMT when the resource was created specified in ISO 8601 format.

  • date_updated string(date-time) | null

    The date and time in GMT when the resource was last updated specified in ISO 8601 format.

  • url string(uri) | null

    The absolute URL of the Service resource.

  • webhook_url string(uri) | null

    The URL we call when Sync objects are manipulated.

  • webhooks_from_rest_enabled boolean | null

    Whether the Service instance should call webhook_url when the REST API is used to update Sync objects. The default is false.

  • reachability_webhooks_enabled boolean | null

    Whether the service instance calls webhook_url when client endpoints connect to Sync. The default is false.

  • acl_enabled boolean | null

    Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. It is disabled (false) by default.

  • reachability_debouncing_enabled boolean | null

    Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event.

  • reachability_debouncing_window integer

    The reachability event delay in milliseconds if reachability_debouncing_enabled = true. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before webhook_url is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.

    Default value is 0.

  • links object(uri-map) | null

    The URLs of related resources.