Skip to main content

List services

GET 

/services

Retrieve a list of services.

Request

Query Parameters

    name string

    The name of the configuration resource

    folder string

    The folder in which the resource is defined

    snippet string

    The snippet in which the resource is defined

    device string

    The device in which the resource is defined

    offset number

    Default value: 0

    The offset into the list of results returned

    limit number

    Default value: 200

    The maximum number of results per page

Responses

OK

Schema
    data object[]
  • Array [
  • id stringrequired

    The UUID of the service

    name stringrequired

    Possible values: <= 63 characters, Value must match regular expression ^[ a-zA-Z\d.-_]+$

    The name of the service

    description string

    Possible values: <= 1023 characters

    protocol object required
    oneOf
    tcp object
    port stringrequired

    Possible values: non-empty and <= 1023 characters

    source_port string

    Possible values: non-empty and <= 1023 characters

    override object
    timeout integer

    Possible values: >= 1 and <= 604800

    Default value: 3600

    tcp session timeout value (in second)

    halfclose_timeout integer

    Possible values: >= 1 and <= 604800

    Default value: 120

    tcp session half-close timeout value (in second)

    timewait_timeout integer

    Possible values: >= 1 and <= 600

    Default value: 15

    tcp session time-wait timeout value (in second)

    tag string[]

    Possible values: <= 64

    Tags for service object

  • ]
  • limit number

    Default value: 200

    offset number

    Default value: 0

    total number
Loading...