Skip to main content
POST
Create protected network

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Body

multipart/form-data
files
file[]
required
Required array length: 1 - 5 elements
network
string<ipv4network>
required
as_number
integer
required
comment
string | null

Response

Successful Response

id
integer
required

Identifier for the protected network

client_id
integer
required

Identifier of the client owning this network

network
required

IP network address (IPv4 or IPv6)

as_number
integer
required

Autonomous System number associated with the network

Example:

65000

gre_endpoint
required

GRE tunnel endpoint IP address

Example:

"172.16.31.10"

status
enum<string>
required

Current administrative status of the network

Available options:
PENDING,
ACTIVE,
INACTIVE,
NEED_INFO,
PROCESSING,
ERROR
protection_status
enum<string>
required

Current protection status of the network (ACTIVE, INACTIVE, NONE)

Available options:
NONE,
ACTIVE,
INACTIVE,
ACTIVATING,
DEACTIVATING,
UPDATING,
ERROR
lifecycle_status
enum<string>
required

Current lifecycle status of the network (PENDING, APPROVED, REJECTED)

Available options:
PENDING,
APPROVED,
REJECTED,
DELETED
comment
string | null
required

Optional comment or note about the network

documents
ProtectedNetworkDocumentResponse · object[]
required

List of associated documents

created_at
string<date-time>
required

Timestamp when the network was created

modified_at
string<date-time> | null
required

Timestamp of the last modification

profile
ProfileInProtectedNetwork · object | null
required

Associated protection profile

Example:
is_active
boolean
required

Whether the network protection is currently active

is_processing
boolean
required

Whether the network is currently being processed

is_error
boolean
required

Whether the network is in an error state