DmzResource
The following resources are part of this group:
- /zones
- /zones/{name}
- /zones/{name}/edges
- /zones/{name}/edges/{title}
- /zones/{name}/edges/{title}/protocols
- /zones/{name}/edges/{title}/proxies
- /zones/{name}/edges/{title}/protocols/{protocol}
- /zones/{name}/edges/{title}/proxies/{proxy}
/zones
GET
Gets the zones.
Parameters
name | description | type | default |
---|---|---|---|
version | (no documentation provided) | path |
Response Body
element: | zones |
all of the zones
POST
Creates zones.
Parameters
name | description | type | default |
---|---|---|---|
version | (no documentation provided) | path |
Request Body
element: | zones |
- the zones to create
/zones/{name}
The following operations are supported on this resource:
GET
Gets the zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
Response Body
element: | zone |
null or zone with given name
PUT
Creates the zone or replaces existing zone with the same name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
Request Body
element: | zone |
- the zone
POST
Updates the fields of existing zone with the same name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
Request Body
element: | zone |
- the zone
DELETE
Deletes a zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
/zones/{name}/edges
GET
Gets the edges for the given zone.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
Response Body
element: | edges |
all of the edges for given zone
POST
Creates the edges for the given zone.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
version | (no documentation provided) | path |
Request Body
element: | edges |
- the edges to create
/zones/{name}/edges/{title}
The following operations are supported on this resource:
GET
Gets an edge with the given title in zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
Response Body
element: | edge |
the edge if exists
PUT
Creates the edge or replaces existing edge with the same name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
Request Body
element: | edge |
- the edge
DELETE
Deletes an edge.
Deleting an edge which is local (such nodes have configurationId specified) should be avoided as it will make your SecureTransport server unusable. This is allowed only in cases where the SecureTransport is configured as a cluster and you're deleting the a local edge of a cluster node that is removed from the cluster. After doing this the removed cluster node can no longer be rejoined to the cluster. You need to start with fresh SecureTransport installation to be able to join the node in the cluster again.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
POST
Updates the given edge properties.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
Request Body
element: | edge |
the edge
/zones/{name}/edges/{title}/protocols
GET
Gets the protocols for the given edge and zone.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
Response Body
element: | protocols |
the edge if exists
/zones/{name}/edges/{title}/proxies
GET
Gets the proxies for the given edge and zone.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
version | (no documentation provided) | path |
Response Body
element: | proxies |
the edge proxy if exists
/zones/{name}/edges/{title}/protocols/{protocol}
GET
Gets a protocol in an edge with the given title in zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
protocol | the streaming protocol | path | |
version | (no documentation provided) | path |
Response Body
element: | protocol |
the target protocol if exists
POST
Updates a protocol in an edge with the given title in zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
protocol | the protocol name | path | |
version | (no documentation provided) | path |
Request Body
element: | protocol |
the edge protocol
/zones/{name}/edges/{title}/proxies/{proxy}
GET
Gets a protocol in an edge with the given title in zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
proxy | the streaming protocol | path | |
version | (no documentation provided) | path |
Response Body
element: | proxy |
the target protocol if exists
POST
Updates a proxy in an edge with the given title in zone with given name.
Parameters
name | description | type | default |
---|---|---|---|
name | - the name of the zone | path | |
title | - the title of the edge | path | |
proxy | the protocol name | path | |
version | (no documentation provided) | path |
Request Body
element: | proxy |
the edge protocol