Skip to main content

List IKE gateways

GET 
/ike-gateways

Retrieve a list of IKE gateways.

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 string

    UUID of the resource

    name stringrequired

    Possible values: <= 63 characters

    Alphanumeric string begin with letter: [0-9a-zA-Z._-]

    authentication object required
    oneOf
    pre_shared_key object
    key password
    peer_id object
    type

    Possible values: [ipaddr, keyid, fqdn, ufqdn]

    id string

    Possible values: non-empty and <= 1024 characters, Value must match regular expression ^(.+\@[\*a-zA-Z0-9.-]+)$|^([\*$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$

    Peer ID string

    local_id object
    type string
    id string

    Possible values: non-empty and <= 1024 characters, Value must match regular expression ^(.+\@[a-zA-Z0-9.-]+)$|^([$a-zA-Z0-9_:.-]+)$|^(([[:xdigit:]][[:xdigit:]])+)$|^([a-zA-Z0-9.]+=(\\,|[^,])+[, ]+)*([a-zA-Z0-9.]+=(\\,|[^,])+)$

    Local ID string

    protocol objectrequired
    ikev1 object
    ike_crypto_profile string
    dpd object
    enable boolean
    ikev2 object
    ike_crypto_profile string
    dpd object
    enable boolean
    version

    Possible values: [ikev2-preferred, ikev1, ikev2]

    Default value: ikev2-preferred

    protocol_common object
    nat_traversal object
    enable boolean
    passive_mode boolean
    fragmentation object
    enable

    Possible values: [false]

    peer_address object required
    oneOf
    ip string

    peer gateway has static IP address

  • ]
    • limit number

    Default value: 200

    offset number

    Default value: 0

    total number
Loading...