API docs by Redocly

FortiGSLB Cloud REST API (1.0)

Download OpenAPI specification:Download

URL: https://www.fortigslb.com License: Fortinet Terms of Service

Overview

FortiGSLB Cloud offers a robust and versatile RESTful API, enabling developers to programmatically access and adjust FortiGSLB application settings. Leveraging this API allows for seamless integration of FortiGSLB Cloud features into your applications, automating tasks and enhancing resource management efficiency.

Authentication

The HTTP request header of FortiGSLB Cloud RESTful API must include:

  • The generated API key from the FortiGSLB Cloud GUI: authorization: Basic <api-key-secret> For instructions on generating the API key, See API Key in the Online Help.

General query parameters

When obtaining a model list, one can utilize the following general query parameters to retrieve the desired and specific data.

  • sort : This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2
  • last_id : The offset of the current model based on its ID.
  • limit : The number of records to be returned.
  • order: The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.
  • fields: The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Supported API methods

Method Operation description
GET Retrieves all configuration information of a model.
POST Creates new configuration of a model.
PUT Updates the specified configuration of a model.
DELETE Deletes the specified configuration of a model.

Meter

Get company rps History

Get company rps History

query Parameters
company_id
required
string

company_id

range
required
string

From 0 to 6, represent the last 1 hour, last 6 hours, last 1 day, last 7 days, last 30 days, and last 365 days.

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Get query usage history

Get query usage history

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Get company status

Get company status

query Parameters
company_id
required
string

company_id

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "payload": {
    }
}

Get server status

Get server status

query Parameters
company_id
required
string

company_id

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Get topology status

Get topology status

query Parameters
host_id
string

At least one parameter from host_id or company_id must be provided.

company_id
string

At least one parameter from host_id or company_id must be provided.

pretty
boolean

indented json response

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Miscellaneous

Get assigned dns servers

Get assigned dns servers

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "payload": {
    }
}

Regenerate zone dnssec by zone ID.

Meter status of a company.

query Parameters
zone_id
required
string

zone_id

Responses

Response samples

Content type
application/json
{
  • "payload": 0
}

Host

Get a host list.

Get a host list.

query Parameters
host_name
string
host_type
string
Enum: "Self-Defined" "Auto-Generated"
host_hostname
string
host_domainname
string
host_singlerecord
string
Enum: "disable" "enable"
host_persistence
string
Enum: "disable" "enable"
host_need_trans
string
host_lbmethod
string
Enum: "Weight" "DNS-Query-Origin" "Global-Availability"
host_defaultip_4
string
host_defaultip_6
string
host_fortiview
string
Enum: "disable" "enable"
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new host

Create a new host

Request Body schema: application/json
required

The host model

company_id
string
host_defaultip_4
string
host_defaultip_6
string
host_domainname
string
host_fortiview
string
Enum: "disable" "enable"
host_hostname
string
host_id
string
host_lbmethod
string
Enum: "Weight" "DNS-Query-Origin" "Global-Availability"
host_name
string
host_need_trans
string
host_persistence
string
Enum: "disable" "enable"
host_singlerecord
string
Enum: "disable" "enable"
host_type
string
Enum: "Self-Defined" "Auto-Generated"
Array of objects (fortinet_com_db_models.HostMember)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "host_defaultip_4": "string",
  • "host_defaultip_6": "string",
  • "host_domainname": "string",
  • "host_fortiview": "",
  • "host_hostname": "string",
  • "host_id": "0",
  • "host_lbmethod": "",
  • "host_name": "string",
  • "host_need_trans": "string",
  • "host_persistence": "",
  • "host_singlerecord": "",
  • "host_type": "",
  • "hostmembers": [
    ]
}

Response samples

Content type
application/json
"string"

Delete a host.

Delete a host.

path Parameters
id
required
string

The ID of the host

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a host by Id.

Get a host by Id.

path Parameters
id
required
string

The ID of the host

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "host_defaultip_4": "string",
  • "host_defaultip_6": "string",
  • "host_domainname": "string",
  • "host_fortiview": "",
  • "host_hostname": "string",
  • "host_id": "0",
  • "host_lbmethod": "",
  • "host_name": "string",
  • "host_need_trans": "string",
  • "host_persistence": "",
  • "host_singlerecord": "",
  • "host_type": "",
  • "hostmembers": [
    ]
}

Update a host.

Update a host.

path Parameters
id
required
string

The ID of the host

Request Body schema: application/json
required

The host model

company_id
string
host_defaultip_4
string
host_defaultip_6
string
host_domainname
string
host_fortiview
string
Enum: "disable" "enable"
host_hostname
string
host_id
string
host_lbmethod
string
Enum: "Weight" "DNS-Query-Origin" "Global-Availability"
host_name
string
host_need_trans
string
host_persistence
string
Enum: "disable" "enable"
host_singlerecord
string
Enum: "disable" "enable"
host_type
string
Enum: "Self-Defined" "Auto-Generated"
Array of objects (fortinet_com_db_models.HostMember)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "host_defaultip_4": "string",
  • "host_defaultip_6": "string",
  • "host_domainname": "string",
  • "host_fortiview": "",
  • "host_hostname": "string",
  • "host_id": "0",
  • "host_lbmethod": "",
  • "host_name": "string",
  • "host_need_trans": "string",
  • "host_persistence": "",
  • "host_singlerecord": "",
  • "host_type": "",
  • "hostmembers": [
    ]
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "host_defaultip_4": "string",
  • "host_defaultip_6": "string",
  • "host_domainname": "string",
  • "host_fortiview": "",
  • "host_hostname": "string",
  • "host_id": "0",
  • "host_lbmethod": "",
  • "host_name": "string",
  • "host_need_trans": "string",
  • "host_persistence": "",
  • "host_singlerecord": "",
  • "host_type": "",
  • "hostmembers": [
    ]
}

BatchRemove Hosts by mkeys

BatchRemove Hosts by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

HostMember

Get a host member list.

Get a host member list.

query Parameters
host_member_name
string
host_member_weight
number
host_id
number
company_id
number
serial
number
virtual_server_pool_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new host member

Create a new host member

Request Body schema: application/json
required

The host member model

object (fortinet_com_db_models.Addressgroup)
object (nulls.UInt64)
company_id
string
host_id
string
host_member_id
string
host_member_name
string
host_member_weight
string
serial
string
object (fortinet_com_db_models.Topology)
object (nulls.UInt64)
object (fortinet_com_db_models.VirtualServerPool)
virtual_server_pool_id
string

Responses

Request samples

Content type
application/json
{
  • "addressgroup": {
    },
  • "addressgroup_id": {
    },
  • "company_id": "0",
  • "host_id": "0",
  • "host_member_id": "0",
  • "host_member_name": "string",
  • "host_member_weight": "0",
  • "serial": "0",
  • "topology": {
    },
  • "topology_id": {
    },
  • "virtual_server_pool": {
    },
  • "virtual_server_pool_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a host member.

Delete a host member.

path Parameters
id
required
string

The ID of the host member

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a host member by Id.

Get a host member by Id.

path Parameters
id
required
string

The ID of the host member

Responses

Response samples

Content type
application/json
{
  • "addressgroup": {
    },
  • "addressgroup_id": {
    },
  • "company_id": "0",
  • "host_id": "0",
  • "host_member_id": "0",
  • "host_member_name": "string",
  • "host_member_weight": "0",
  • "serial": "0",
  • "topology": {
    },
  • "topology_id": {
    },
  • "virtual_server_pool": {
    },
  • "virtual_server_pool_id": "0"
}

Update a host member.

Update a host member.

path Parameters
id
required
string

The ID of the host member

Request Body schema: application/json
required

The host member model

object (fortinet_com_db_models.Addressgroup)
object (nulls.UInt64)
company_id
string
host_id
string
host_member_id
string
host_member_name
string
host_member_weight
string
serial
string
object (fortinet_com_db_models.Topology)
object (nulls.UInt64)
object (fortinet_com_db_models.VirtualServerPool)
virtual_server_pool_id
string

Responses

Request samples

Content type
application/json
{
  • "addressgroup": {
    },
  • "addressgroup_id": {
    },
  • "company_id": "0",
  • "host_id": "0",
  • "host_member_id": "0",
  • "host_member_name": "string",
  • "host_member_weight": "0",
  • "serial": "0",
  • "topology": {
    },
  • "topology_id": {
    },
  • "virtual_server_pool": {
    },
  • "virtual_server_pool_id": "0"
}

Response samples

Content type
application/json
{
  • "addressgroup": {
    },
  • "addressgroup_id": {
    },
  • "company_id": "0",
  • "host_id": "0",
  • "host_member_id": "0",
  • "host_member_name": "string",
  • "host_member_weight": "0",
  • "serial": "0",
  • "topology": {
    },
  • "topology_id": {
    },
  • "virtual_server_pool": {
    },
  • "virtual_server_pool_id": "0"
}

BatchRemove HostMembers by mkeys

BatchRemove HostMembers by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Topology

Get a topology list.

Get a topology list.

query Parameters
topology_name
string
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new topology

Create a new topology

Request Body schema: application/json
required

The topology model

company_id
string
Array of objects (fortinet_com_db_models.Region)
topology_id
string
topology_name
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "regions": [
    ],
  • "topology_id": "0",
  • "topology_name": "string"
}

Response samples

Content type
application/json
"string"

Delete a topology.

Delete a topology.

path Parameters
id
required
string

The ID of the topology

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a topology by Id.

Get a topology by Id.

path Parameters
id
required
string

The ID of the topology

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "regions": [
    ],
  • "topology_id": "0",
  • "topology_name": "string"
}

Update a topology.

Update a topology.

path Parameters
id
required
string

The ID of the topology

Request Body schema: application/json
required

The topology model

company_id
string
Array of objects (fortinet_com_db_models.Region)
topology_id
string
topology_name
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "regions": [
    ],
  • "topology_id": "0",
  • "topology_name": "string"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "regions": [
    ],
  • "topology_id": "0",
  • "topology_name": "string"
}

BatchRemove Topologies by mkeys

BatchRemove Topologies by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

VirtualServer

Get a virtual server list.

Get a virtual server list.

query Parameters
virtual_server_name
string
virtual_server_ip_type
string
Enum: "IPv4" "IPv6"
virtual_server_ip_4
string
virtual_server_ip_6
string
virtual_server_gatewayname
string
virtual_server_hostname
string
virtual_server_domainname
string
virtual_server_hc_inherit
string
Enum: "disable" "enable"
virtual_server_hc
string
Enum: "disable" "enable"
virtual_server_hc_relation
string
Enum: "AND" "OR"
server_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new virtual server

Create a new virtual server

Request Body schema: application/json
required

The virtual server model

company_id
string
Array of objects (fortinet_com_db_models.HealthCheck)
server_id
string
virtual_server_domainname
string
virtual_server_gatewayname
string
virtual_server_hc
string
Enum: "disable" "enable"
virtual_server_hc_inherit
string
Enum: "disable" "enable"
virtual_server_hc_relation
string
Enum: "AND" "OR"
virtual_server_hostname
string
virtual_server_id
string
virtual_server_ip_4
string
virtual_server_ip_6
string
virtual_server_ip_type
string
Enum: "IPv4" "IPv6"
virtual_server_name
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "server_id": "0",
  • "virtual_server_domainname": "string",
  • "virtual_server_gatewayname": "string",
  • "virtual_server_hc": "",
  • "virtual_server_hc_inherit": "",
  • "virtual_server_hc_relation": "",
  • "virtual_server_hostname": "string",
  • "virtual_server_id": "0",
  • "virtual_server_ip_4": "string",
  • "virtual_server_ip_6": "string",
  • "virtual_server_ip_type": "",
  • "virtual_server_name": "string"
}

Response samples

Content type
application/json
"string"

Delete a virtual server.

Delete a virtual server.

path Parameters
id
required
string

The ID of the virtual server

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a virtual server by Id.

Get a virtual server by Id.

path Parameters
id
required
string

The ID of the virtual server

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "server_id": "0",
  • "virtual_server_domainname": "string",
  • "virtual_server_gatewayname": "string",
  • "virtual_server_hc": "",
  • "virtual_server_hc_inherit": "",
  • "virtual_server_hc_relation": "",
  • "virtual_server_hostname": "string",
  • "virtual_server_id": "0",
  • "virtual_server_ip_4": "string",
  • "virtual_server_ip_6": "string",
  • "virtual_server_ip_type": "",
  • "virtual_server_name": "string"
}

Update a virtual server.

Update a virtual server.

path Parameters
id
required
string

The ID of the virtual server

Request Body schema: application/json
required

The virtual server model

company_id
string
Array of objects (fortinet_com_db_models.HealthCheck)
server_id
string
virtual_server_domainname
string
virtual_server_gatewayname
string
virtual_server_hc
string
Enum: "disable" "enable"
virtual_server_hc_inherit
string
Enum: "disable" "enable"
virtual_server_hc_relation
string
Enum: "AND" "OR"
virtual_server_hostname
string
virtual_server_id
string
virtual_server_ip_4
string
virtual_server_ip_6
string
virtual_server_ip_type
string
Enum: "IPv4" "IPv6"
virtual_server_name
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "server_id": "0",
  • "virtual_server_domainname": "string",
  • "virtual_server_gatewayname": "string",
  • "virtual_server_hc": "",
  • "virtual_server_hc_inherit": "",
  • "virtual_server_hc_relation": "",
  • "virtual_server_hostname": "string",
  • "virtual_server_id": "0",
  • "virtual_server_ip_4": "string",
  • "virtual_server_ip_6": "string",
  • "virtual_server_ip_type": "",
  • "virtual_server_name": "string"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "server_id": "0",
  • "virtual_server_domainname": "string",
  • "virtual_server_gatewayname": "string",
  • "virtual_server_hc": "",
  • "virtual_server_hc_inherit": "",
  • "virtual_server_hc_relation": "",
  • "virtual_server_hostname": "string",
  • "virtual_server_id": "0",
  • "virtual_server_ip_4": "string",
  • "virtual_server_ip_6": "string",
  • "virtual_server_ip_type": "",
  • "virtual_server_name": "string"
}

BatchRemove VirtualServers by mkeys

BatchRemove VirtualServers by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

VirtualServerPool

Get a virtual server pool list.

Get a virtual server pool list.

query Parameters
virtual_server_pool_name
string
virtual_server_pool_schedule_method
string

Enum: ''Weight'' ''GEO'' ''GEOISP'' ''RTT'' ''Least-Connection(FortiADC)'' ''Connection-Limit(FortiADC)'' ''Bytes-Per-Second(FortiADC)'' ''Server-Performance(FortiADC/FortiGate)'' ''SDWAN-InBandwidth(FortiGate)'' ''SDWAN-OutBandwidth(FortiGate)'' ''SDWAN-BiBandwidth(FortiGate)''

virtual_server_pool_cmr
number
virtual_server_pool_server_hc
string
Enum: "disable" "enable"
virtual_server_pool_virtual_server_hc
string
Enum: "disable" "enable"
virtual_server_pool_lb_method
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new virtual server pool

Create a new virtual server pool

Request Body schema: application/json
required

The virtual server pool model

company_id
string
virtual_server_pool_cmr
string
virtual_server_pool_id
string
virtual_server_pool_lb_method
string
virtual_server_pool_name
string
virtual_server_pool_schedule_method
string
Enum: "Weight" "GEO" "GEOISP" "RTT" "Least-Connection(FortiADC)" "Connection-Limit(FortiADC)" "Bytes-Per-Second(FortiADC)" "Server-Performance(FortiADC/FortiGate)" "SDWAN-InBandwidth(FortiGate)" "SDWAN-OutBandwidth(FortiGate)" "SDWAN-BiBandwidth(FortiGate)"
virtual_server_pool_server_hc
string
Enum: "disable" "enable"
virtual_server_pool_virtual_server_hc
string
Enum: "disable" "enable"
Array of objects (fortinet_com_db_models.VspMember)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_pool_cmr": "0",
  • "virtual_server_pool_id": "0",
  • "virtual_server_pool_lb_method": "0",
  • "virtual_server_pool_name": "string",
  • "virtual_server_pool_schedule_method": "",
  • "virtual_server_pool_server_hc": "",
  • "virtual_server_pool_virtual_server_hc": "",
  • "vspmembers": [
    ]
}

Response samples

Content type
application/json
"string"

Delete a virtual server pool.

Delete a virtual server pool.

path Parameters
id
required
string

The ID of the virtual server pool

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a virtual server pool by Id.

Get a virtual server pool by Id.

path Parameters
id
required
string

The ID of the virtual server pool

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_pool_cmr": "0",
  • "virtual_server_pool_id": "0",
  • "virtual_server_pool_lb_method": "0",
  • "virtual_server_pool_name": "string",
  • "virtual_server_pool_schedule_method": "",
  • "virtual_server_pool_server_hc": "",
  • "virtual_server_pool_virtual_server_hc": "",
  • "vspmembers": [
    ]
}

Update a virtual server pool.

Update a virtual server pool.

path Parameters
id
required
string

The ID of the virtual server pool

Request Body schema: application/json
required

The virtual server pool model

company_id
string
virtual_server_pool_cmr
string
virtual_server_pool_id
string
virtual_server_pool_lb_method
string
virtual_server_pool_name
string
virtual_server_pool_schedule_method
string
Enum: "Weight" "GEO" "GEOISP" "RTT" "Least-Connection(FortiADC)" "Connection-Limit(FortiADC)" "Bytes-Per-Second(FortiADC)" "Server-Performance(FortiADC/FortiGate)" "SDWAN-InBandwidth(FortiGate)" "SDWAN-OutBandwidth(FortiGate)" "SDWAN-BiBandwidth(FortiGate)"
virtual_server_pool_server_hc
string
Enum: "disable" "enable"
virtual_server_pool_virtual_server_hc
string
Enum: "disable" "enable"
Array of objects (fortinet_com_db_models.VspMember)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_pool_cmr": "0",
  • "virtual_server_pool_id": "0",
  • "virtual_server_pool_lb_method": "0",
  • "virtual_server_pool_name": "string",
  • "virtual_server_pool_schedule_method": "",
  • "virtual_server_pool_server_hc": "",
  • "virtual_server_pool_virtual_server_hc": "",
  • "vspmembers": [
    ]
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_pool_cmr": "0",
  • "virtual_server_pool_id": "0",
  • "virtual_server_pool_lb_method": "0",
  • "virtual_server_pool_name": "string",
  • "virtual_server_pool_schedule_method": "",
  • "virtual_server_pool_server_hc": "",
  • "virtual_server_pool_virtual_server_hc": "",
  • "vspmembers": [
    ]
}

BatchRemove VirtualServerPools by mkeys

BatchRemove VirtualServerPools by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

VirtualServerStatus

Get a virtual server status list.

Get a virtual server status list.

query Parameters
vs_id
number
server_id
number
company_id
number
status
number
vs_running_status
number
sess_count
number
sess_limit
number
throughput
number
inbytes
number
outbytes
number
time_stamp
string
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a virtual server status by Id.

Get a virtual server status by Id.

path Parameters
id
required
string

The ID of the virtual server status

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "inbytes": "0",
  • "outbytes": "0",
  • "server_id": "0",
  • "sess_count": "0",
  • "sess_limit": "0",
  • "status": "0",
  • "throughput": "0",
  • "time_stamp": "string",
  • "vs_id": "0",
  • "vs_running_status": "0"
}

VspMember

Get a vsp member list.

Get a vsp member list.

query Parameters
vsp_member_ttl
number
vsp_member_weight
number
vsp_member_backup
string
Enum: "disable" "enable"
virtual_server_pool_id
number
company_id
number
virtual_server_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new vsp member

Create a new vsp member

Request Body schema: application/json
required

The vsp member model

company_id
string
virtual_server_id
string
virtual_server_pool_id
string
object (fortinet_com_db_models.VirtualServer)
vsp_member_backup
string
Enum: "disable" "enable"
vsp_member_id
string
vsp_member_ttl
string
vsp_member_weight
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_id": "0",
  • "virtual_server_pool_id": "0",
  • "virtualserver": {
    },
  • "vsp_member_backup": "",
  • "vsp_member_id": "0",
  • "vsp_member_ttl": "0",
  • "vsp_member_weight": "0"
}

Response samples

Content type
application/json
"string"

Delete a vsp member.

Delete a vsp member.

path Parameters
id
required
string

The ID of the vsp member

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a vsp member by Id.

Get a vsp member by Id.

path Parameters
id
required
string

The ID of the vsp member

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_id": "0",
  • "virtual_server_pool_id": "0",
  • "virtualserver": {
    },
  • "vsp_member_backup": "",
  • "vsp_member_id": "0",
  • "vsp_member_ttl": "0",
  • "vsp_member_weight": "0"
}

Update a vsp member.

Update a vsp member.

path Parameters
id
required
string

The ID of the vsp member

Request Body schema: application/json
required

The vsp member model

company_id
string
virtual_server_id
string
virtual_server_pool_id
string
object (fortinet_com_db_models.VirtualServer)
vsp_member_backup
string
Enum: "disable" "enable"
vsp_member_id
string
vsp_member_ttl
string
vsp_member_weight
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_id": "0",
  • "virtual_server_pool_id": "0",
  • "virtualserver": {
    },
  • "vsp_member_backup": "",
  • "vsp_member_id": "0",
  • "vsp_member_ttl": "0",
  • "vsp_member_weight": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "virtual_server_id": "0",
  • "virtual_server_pool_id": "0",
  • "virtualserver": {
    },
  • "vsp_member_backup": "",
  • "vsp_member_id": "0",
  • "vsp_member_ttl": "0",
  • "vsp_member_weight": "0"
}

BatchRemove VspMembers by mkeys

BatchRemove VspMembers by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

ARecord

Get an a record list.

Get an a record list.

query Parameters
a_record_hostname
string
a_record_ip_type
string
Enum: "IPv4" "IPv6"
a_record_ip_4
string
a_record_ip_6
string
a_record_weight
number
a_record_ttl
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new a record

Create a new a record

Request Body schema: application/json
required

The a record model

a_record_hostname
string
a_record_id
string
a_record_ip_4
string
a_record_ip_6
string
a_record_ip_type
string
Enum: "IPv4" "IPv6"
a_record_ttl
string
a_record_weight
string
company_id
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "a_record_hostname": "string",
  • "a_record_id": "0",
  • "a_record_ip_4": "string",
  • "a_record_ip_6": "string",
  • "a_record_ip_type": "",
  • "a_record_ttl": "0",
  • "a_record_weight": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete an a record.

Delete an a record.

path Parameters
id
required
string

The ID of the a record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get an a record by Id.

Get an a record by Id.

path Parameters
id
required
string

The ID of the a record

Responses

Response samples

Content type
application/json
{
  • "a_record_hostname": "string",
  • "a_record_id": "0",
  • "a_record_ip_4": "string",
  • "a_record_ip_6": "string",
  • "a_record_ip_type": "",
  • "a_record_ttl": "0",
  • "a_record_weight": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Update an a record.

Update an a record.

path Parameters
id
required
string

The ID of the a record

Request Body schema: application/json
required

The a record model

a_record_hostname
string
a_record_id
string
a_record_ip_4
string
a_record_ip_6
string
a_record_ip_type
string
Enum: "IPv4" "IPv6"
a_record_ttl
string
a_record_weight
string
company_id
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "a_record_hostname": "string",
  • "a_record_id": "0",
  • "a_record_ip_4": "string",
  • "a_record_ip_6": "string",
  • "a_record_ip_type": "",
  • "a_record_ttl": "0",
  • "a_record_weight": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "a_record_hostname": "string",
  • "a_record_id": "0",
  • "a_record_ip_4": "string",
  • "a_record_ip_6": "string",
  • "a_record_ip_type": "",
  • "a_record_ttl": "0",
  • "a_record_weight": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

BatchRemove ARecords by mkeys

BatchRemove ARecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

CnameRecord

Get a cname record list.

Get a cname record list.

query Parameters
cname_record_alias
string
cname_record_target
string
cname_record_ttl
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new cname record

Create a new cname record

Request Body schema: application/json
required

The cname record model

cname_record_alias
string
cname_record_id
string
cname_record_target
string
cname_record_ttl
string
company_id
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "cname_record_alias": "string",
  • "cname_record_id": "0",
  • "cname_record_target": "string",
  • "cname_record_ttl": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a cname record.

Delete a cname record.

path Parameters
id
required
string

The ID of the cname record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a cname record by Id.

Get a cname record by Id.

path Parameters
id
required
string

The ID of the cname record

Responses

Response samples

Content type
application/json
{
  • "cname_record_alias": "string",
  • "cname_record_id": "0",
  • "cname_record_target": "string",
  • "cname_record_ttl": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Update a cname record.

Update a cname record.

path Parameters
id
required
string

The ID of the cname record

Request Body schema: application/json
required

The cname record model

cname_record_alias
string
cname_record_id
string
cname_record_target
string
cname_record_ttl
string
company_id
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "cname_record_alias": "string",
  • "cname_record_id": "0",
  • "cname_record_target": "string",
  • "cname_record_ttl": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "cname_record_alias": "string",
  • "cname_record_id": "0",
  • "cname_record_target": "string",
  • "cname_record_ttl": "0",
  • "company_id": "0",
  • "zone_id": "0"
}

BatchRemove CnameRecords by mkeys

BatchRemove CnameRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Dnssec

Get a dnssec list.

Get a dnssec list.

query Parameters
dnssec_zsk_name
string
dnssec_zsk
string
dnssec_zsp_name
string
dnssec_zsp
string
dnssec_ksk_name
string
dnssec_ksk
string
dnssec_ksp_name
string
dnssec_ksp
string
dnssec_dsset_name
string
dnssec_dsset
string
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dnssec

Create a new dnssec

Request Body schema: application/json
required

The dnssec model

company_id
string
dnssec_dsset
string
dnssec_dsset_name
string
dnssec_id
string
dnssec_ksk
string
dnssec_ksk_name
string
dnssec_ksp
string
dnssec_ksp_name
string
dnssec_zsk
string
dnssec_zsk_name
string
dnssec_zsp
string
dnssec_zsp_name
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "dnssec_dsset": "string",
  • "dnssec_dsset_name": "string",
  • "dnssec_id": "0",
  • "dnssec_ksk": "string",
  • "dnssec_ksk_name": "string",
  • "dnssec_ksp": "string",
  • "dnssec_ksp_name": "string",
  • "dnssec_zsk": "string",
  • "dnssec_zsk_name": "string",
  • "dnssec_zsp": "string",
  • "dnssec_zsp_name": "string",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a dnssec.

Delete a dnssec.

path Parameters
id
required
string

The ID of the dnssec

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a dnssec by Id.

Get a dnssec by Id.

path Parameters
id
required
string

The ID of the dnssec

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "dnssec_dsset": "string",
  • "dnssec_dsset_name": "string",
  • "dnssec_id": "0",
  • "dnssec_ksk": "string",
  • "dnssec_ksk_name": "string",
  • "dnssec_ksp": "string",
  • "dnssec_ksp_name": "string",
  • "dnssec_zsk": "string",
  • "dnssec_zsk_name": "string",
  • "dnssec_zsp": "string",
  • "dnssec_zsp_name": "string",
  • "zone_id": "0"
}

Update a dnssec.

Update a dnssec.

path Parameters
id
required
string

The ID of the dnssec

Request Body schema: application/json
required

The dnssec model

company_id
string
dnssec_dsset
string
dnssec_dsset_name
string
dnssec_id
string
dnssec_ksk
string
dnssec_ksk_name
string
dnssec_ksp
string
dnssec_ksp_name
string
dnssec_zsk
string
dnssec_zsk_name
string
dnssec_zsp
string
dnssec_zsp_name
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "dnssec_dsset": "string",
  • "dnssec_dsset_name": "string",
  • "dnssec_id": "0",
  • "dnssec_ksk": "string",
  • "dnssec_ksk_name": "string",
  • "dnssec_ksp": "string",
  • "dnssec_ksp_name": "string",
  • "dnssec_zsk": "string",
  • "dnssec_zsk_name": "string",
  • "dnssec_zsp": "string",
  • "dnssec_zsp_name": "string",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "dnssec_dsset": "string",
  • "dnssec_dsset_name": "string",
  • "dnssec_id": "0",
  • "dnssec_ksk": "string",
  • "dnssec_ksk_name": "string",
  • "dnssec_ksp": "string",
  • "dnssec_ksp_name": "string",
  • "dnssec_zsk": "string",
  • "dnssec_zsk_name": "string",
  • "dnssec_zsp": "string",
  • "dnssec_zsp_name": "string",
  • "zone_id": "0"
}

BatchRemove Dnssecs by mkeys

BatchRemove Dnssecs by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Dsset

Get a dsset list.

Get a dsset list.

query Parameters
dsset_name
string
dsset_key
string
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dsset

Create a new dsset

Request Body schema: application/json
required

The dsset model

company_id
string
dsset_id
string
dsset_key
string
dsset_name
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "dsset_id": "0",
  • "dsset_key": "string",
  • "dsset_name": "string",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a dsset.

Delete a dsset.

path Parameters
id
required
string

The ID of the dsset

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a dsset by Id.

Get a dsset by Id.

path Parameters
id
required
string

The ID of the dsset

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "dsset_id": "0",
  • "dsset_key": "string",
  • "dsset_name": "string",
  • "zone_id": "0"
}

Update a dsset.

Update a dsset.

path Parameters
id
required
string

The ID of the dsset

Request Body schema: application/json
required

The dsset model

company_id
string
dsset_id
string
dsset_key
string
dsset_name
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "dsset_id": "0",
  • "dsset_key": "string",
  • "dsset_name": "string",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "dsset_id": "0",
  • "dsset_key": "string",
  • "dsset_name": "string",
  • "zone_id": "0"
}

BatchRemove Dssets by mkeys

BatchRemove Dssets by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

MxRecord

Get a mx record list.

Get a mx record list.

query Parameters
mx_record_domainname
string
mx_record_hostname
string
mx_record_ip_type
string
Enum: "IPv4" "IPv6"
mx_record_ip_4
string
mx_record_ip_6
string
mx_record_ttl
number
mx_record_priority
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new mx record

Create a new mx record

Request Body schema: application/json
required

The mx record model

company_id
string
mx_record_domainname
string
mx_record_hostname
string
mx_record_id
string
mx_record_ip_4
string
mx_record_ip_6
string
mx_record_ip_type
string
Enum: "IPv4" "IPv6"
mx_record_priority
string
mx_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "mx_record_domainname": "string",
  • "mx_record_hostname": "string",
  • "mx_record_id": "0",
  • "mx_record_ip_4": "string",
  • "mx_record_ip_6": "string",
  • "mx_record_ip_type": "",
  • "mx_record_priority": "0",
  • "mx_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a mx record.

Delete a mx record.

path Parameters
id
required
string

The ID of the mx record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a mx record by Id.

Get a mx record by Id.

path Parameters
id
required
string

The ID of the mx record

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "mx_record_domainname": "string",
  • "mx_record_hostname": "string",
  • "mx_record_id": "0",
  • "mx_record_ip_4": "string",
  • "mx_record_ip_6": "string",
  • "mx_record_ip_type": "",
  • "mx_record_priority": "0",
  • "mx_record_ttl": "0",
  • "zone_id": "0"
}

Update a mx record.

Update a mx record.

path Parameters
id
required
string

The ID of the mx record

Request Body schema: application/json
required

The mx record model

company_id
string
mx_record_domainname
string
mx_record_hostname
string
mx_record_id
string
mx_record_ip_4
string
mx_record_ip_6
string
mx_record_ip_type
string
Enum: "IPv4" "IPv6"
mx_record_priority
string
mx_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "mx_record_domainname": "string",
  • "mx_record_hostname": "string",
  • "mx_record_id": "0",
  • "mx_record_ip_4": "string",
  • "mx_record_ip_6": "string",
  • "mx_record_ip_type": "",
  • "mx_record_priority": "0",
  • "mx_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "mx_record_domainname": "string",
  • "mx_record_hostname": "string",
  • "mx_record_id": "0",
  • "mx_record_ip_4": "string",
  • "mx_record_ip_6": "string",
  • "mx_record_ip_type": "",
  • "mx_record_priority": "0",
  • "mx_record_ttl": "0",
  • "zone_id": "0"
}

BatchRemove MxRecords by mkeys

BatchRemove MxRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

NsRecord

Get a ns record list.

Get a ns record list.

query Parameters
ns_record_domainname
string
ns_record_hostname
string
ns_record_ip_type
string
Enum: "IPv4" "IPv6"
ns_record_ip_4
string
ns_record_ip_6
string
ns_record_ttl
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new ns record

Create a new ns record

Request Body schema: application/json
required

The ns record model

company_id
string
ns_record_domainname
string
ns_record_hostname
string
ns_record_id
string
ns_record_ip_4
string
ns_record_ip_6
string
ns_record_ip_type
string
Enum: "IPv4" "IPv6"
ns_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "ns_record_domainname": "string",
  • "ns_record_hostname": "string",
  • "ns_record_id": "0",
  • "ns_record_ip_4": "string",
  • "ns_record_ip_6": "string",
  • "ns_record_ip_type": "",
  • "ns_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a ns record.

Delete a ns record.

path Parameters
id
required
string

The ID of the ns record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a ns record by Id.

Get a ns record by Id.

path Parameters
id
required
string

The ID of the ns record

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "ns_record_domainname": "string",
  • "ns_record_hostname": "string",
  • "ns_record_id": "0",
  • "ns_record_ip_4": "string",
  • "ns_record_ip_6": "string",
  • "ns_record_ip_type": "",
  • "ns_record_ttl": "0",
  • "zone_id": "0"
}

Update a ns record.

Update a ns record.

path Parameters
id
required
string

The ID of the ns record

Request Body schema: application/json
required

The ns record model

company_id
string
ns_record_domainname
string
ns_record_hostname
string
ns_record_id
string
ns_record_ip_4
string
ns_record_ip_6
string
ns_record_ip_type
string
Enum: "IPv4" "IPv6"
ns_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "ns_record_domainname": "string",
  • "ns_record_hostname": "string",
  • "ns_record_id": "0",
  • "ns_record_ip_4": "string",
  • "ns_record_ip_6": "string",
  • "ns_record_ip_type": "",
  • "ns_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "ns_record_domainname": "string",
  • "ns_record_hostname": "string",
  • "ns_record_id": "0",
  • "ns_record_ip_4": "string",
  • "ns_record_ip_6": "string",
  • "ns_record_ip_type": "",
  • "ns_record_ttl": "0",
  • "zone_id": "0"
}

BatchRemove NsRecords by mkeys

BatchRemove NsRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

PtrRecord

Get a ptr record list.

Get a ptr record list.

query Parameters
ptr_record_address
string
ptr_record_fqdn
string
ptr_record_ttl
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new ptr record

Create a new ptr record

Request Body schema: application/json
required

The ptr record model

company_id
string
ptr_record_address
string
ptr_record_fqdn
string
ptr_record_id
string
ptr_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "ptr_record_address": "string",
  • "ptr_record_fqdn": "string",
  • "ptr_record_id": "0",
  • "ptr_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a ptr record.

Delete a ptr record.

path Parameters
id
required
string

The ID of the ptr record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a ptr record by Id.

Get a ptr record by Id.

path Parameters
id
required
string

The ID of the ptr record

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "ptr_record_address": "string",
  • "ptr_record_fqdn": "string",
  • "ptr_record_id": "0",
  • "ptr_record_ttl": "0",
  • "zone_id": "0"
}

Update a ptr record.

Update a ptr record.

path Parameters
id
required
string

The ID of the ptr record

Request Body schema: application/json
required

The ptr record model

company_id
string
ptr_record_address
string
ptr_record_fqdn
string
ptr_record_id
string
ptr_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "ptr_record_address": "string",
  • "ptr_record_fqdn": "string",
  • "ptr_record_id": "0",
  • "ptr_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "ptr_record_address": "string",
  • "ptr_record_fqdn": "string",
  • "ptr_record_id": "0",
  • "ptr_record_ttl": "0",
  • "zone_id": "0"
}

BatchRemove PtrRecords by mkeys

BatchRemove PtrRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

SrvRecord

Get a srv record list.

Get a srv record list.

query Parameters
srv_record_hostname
string
srv_record_targetname
string
srv_record_ttl
number
srv_record_weight
number
srv_record_port
number
srv_record_priorty
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new srv record

Create a new srv record

Request Body schema: application/json
required

The srv record model

company_id
string
srv_record_hostname
string
srv_record_id
string
srv_record_port
string
srv_record_priorty
string
srv_record_targetname
string
srv_record_ttl
string
srv_record_weight
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "srv_record_hostname": "string",
  • "srv_record_id": "0",
  • "srv_record_port": "0",
  • "srv_record_priorty": "0",
  • "srv_record_targetname": "string",
  • "srv_record_ttl": "0",
  • "srv_record_weight": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a srv record.

Delete a srv record.

path Parameters
id
required
string

The ID of the srv record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a srv record by Id.

Get a srv record by Id.

path Parameters
id
required
string

The ID of the srv record

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "srv_record_hostname": "string",
  • "srv_record_id": "0",
  • "srv_record_port": "0",
  • "srv_record_priorty": "0",
  • "srv_record_targetname": "string",
  • "srv_record_ttl": "0",
  • "srv_record_weight": "0",
  • "zone_id": "0"
}

Update a srv record.

Update a srv record.

path Parameters
id
required
string

The ID of the srv record

Request Body schema: application/json
required

The srv record model

company_id
string
srv_record_hostname
string
srv_record_id
string
srv_record_port
string
srv_record_priorty
string
srv_record_targetname
string
srv_record_ttl
string
srv_record_weight
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "srv_record_hostname": "string",
  • "srv_record_id": "0",
  • "srv_record_port": "0",
  • "srv_record_priorty": "0",
  • "srv_record_targetname": "string",
  • "srv_record_ttl": "0",
  • "srv_record_weight": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "srv_record_hostname": "string",
  • "srv_record_id": "0",
  • "srv_record_port": "0",
  • "srv_record_priorty": "0",
  • "srv_record_targetname": "string",
  • "srv_record_ttl": "0",
  • "srv_record_weight": "0",
  • "zone_id": "0"
}

BatchRemove SrvRecords by mkeys

BatchRemove SrvRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

TxtRecord

Get a txt record list.

Get a txt record list.

query Parameters
txt_record_name
string
txt_record_text
string
txt_record_ttl
number
zone_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new txt record

Create a new txt record

Request Body schema: application/json
required

The txt record model

company_id
string
txt_record_id
string
txt_record_name
string
txt_record_text
string
txt_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "txt_record_id": "0",
  • "txt_record_name": "string",
  • "txt_record_text": "string",
  • "txt_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a txt record.

Delete a txt record.

path Parameters
id
required
string

The ID of the txt record

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a txt record by Id.

Get a txt record by Id.

path Parameters
id
required
string

The ID of the txt record

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "txt_record_id": "0",
  • "txt_record_name": "string",
  • "txt_record_text": "string",
  • "txt_record_ttl": "0",
  • "zone_id": "0"
}

Update a txt record.

Update a txt record.

path Parameters
id
required
string

The ID of the txt record

Request Body schema: application/json
required

The txt record model

company_id
string
txt_record_id
string
txt_record_name
string
txt_record_text
string
txt_record_ttl
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "txt_record_id": "0",
  • "txt_record_name": "string",
  • "txt_record_text": "string",
  • "txt_record_ttl": "0",
  • "zone_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "txt_record_id": "0",
  • "txt_record_name": "string",
  • "txt_record_text": "string",
  • "txt_record_ttl": "0",
  • "zone_id": "0"
}

BatchRemove TxtRecords by mkeys

BatchRemove TxtRecords by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Zone

Get a zone list.

Get a zone list.

query Parameters
zone_name
string
zone_status
string
Enum: "disable" "enable"
zone_type
string
Enum: "Primary" "Secondary" "FQDN-Generate"
zone_domainname
string
zone_responsible_mail
string
zone_primary_server
string
zone_primary_server_ip
string
zone_primary_server_ip_6
string
zone_ttl
number
zone_serial
number
zone_negative_ttl
number
zone_notify_status
string
Enum: "disable" "enable"
zone_allow_transfer
string
zone_dnssec_status
string
Enum: "disable" "enable"
zone_dnssec_ready
string
Enum: "disable" "enable"
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new zone

Create a new zone

Request Body schema: application/json
required

The zone model

Array of objects (fortinet_com_db_models.ARecord)
Array of objects (fortinet_com_db_models.CnameRecord)
company_id
string
object (fortinet_com_db_models.Dnssec)
Array of objects (fortinet_com_db_models.Dsset)
Array of objects (fortinet_com_db_models.MxRecord)
Array of objects (fortinet_com_db_models.NsRecord)
Array of objects (fortinet_com_db_models.PtrRecord)
Array of objects (fortinet_com_db_models.SrvRecord)
Array of objects (fortinet_com_db_models.TxtRecord)
zone_allow_transfer
string
zone_alsonotify_server_ip
Array of strings
zone_dnssec_ready
string
Enum: "disable" "enable"
zone_dnssec_status
string
Enum: "disable" "enable"
zone_domainname
string
zone_id
string
zone_name
string
zone_negative_ttl
string
zone_notify_status
string
Enum: "disable" "enable"
zone_primary_server
string
zone_primary_server_ip
string
zone_primary_server_ip_6
string
zone_responsible_mail
string
zone_serial
string
zone_status
string
Enum: "disable" "enable"
zone_ttl
string
zone_type
string
Enum: "Primary" "Secondary" "FQDN-Generate"

Responses

Request samples

Content type
application/json
{
  • "arecords": [
    ],
  • "cnamerecords": [
    ],
  • "company_id": "0",
  • "dnssec_key": {
    },
  • "dssets": [
    ],
  • "mxrecords": [
    ],
  • "nsrecords": [
    ],
  • "ptrrecords": [
    ],
  • "srvrecords": [
    ],
  • "txtrecords": [
    ],
  • "zone_allow_transfer": "string",
  • "zone_alsonotify_server_ip": [
    ],
  • "zone_dnssec_ready": "",
  • "zone_dnssec_status": "",
  • "zone_domainname": "string",
  • "zone_id": "0",
  • "zone_name": "string",
  • "zone_negative_ttl": "0",
  • "zone_notify_status": "",
  • "zone_primary_server": "string",
  • "zone_primary_server_ip": "string",
  • "zone_primary_server_ip_6": "string",
  • "zone_responsible_mail": "string",
  • "zone_serial": "0",
  • "zone_status": "",
  • "zone_ttl": "0",
  • "zone_type": ""
}

Response samples

Content type
application/json
"string"

Delete a zone.

Delete a zone.

path Parameters
id
required
string

The ID of the zone

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a zone by Id.

Get a zone by Id.

path Parameters
id
required
string

The ID of the zone

Responses

Response samples

Content type
application/json
{
  • "arecords": [
    ],
  • "cnamerecords": [
    ],
  • "company_id": "0",
  • "dnssec_key": {
    },
  • "dssets": [
    ],
  • "mxrecords": [
    ],
  • "nsrecords": [
    ],
  • "ptrrecords": [
    ],
  • "srvrecords": [
    ],
  • "txtrecords": [
    ],
  • "zone_allow_transfer": "string",
  • "zone_alsonotify_server_ip": [
    ],
  • "zone_dnssec_ready": "",
  • "zone_dnssec_status": "",
  • "zone_domainname": "string",
  • "zone_id": "0",
  • "zone_name": "string",
  • "zone_negative_ttl": "0",
  • "zone_notify_status": "",
  • "zone_primary_server": "string",
  • "zone_primary_server_ip": "string",
  • "zone_primary_server_ip_6": "string",
  • "zone_responsible_mail": "string",
  • "zone_serial": "0",
  • "zone_status": "",
  • "zone_ttl": "0",
  • "zone_type": ""
}

Update a zone.

Update a zone.

path Parameters
id
required
string

The ID of the zone

Request Body schema: application/json
required

The zone model

Array of objects (fortinet_com_db_models.ARecord)
Array of objects (fortinet_com_db_models.CnameRecord)
company_id
string
object (fortinet_com_db_models.Dnssec)
Array of objects (fortinet_com_db_models.Dsset)
Array of objects (fortinet_com_db_models.MxRecord)
Array of objects (fortinet_com_db_models.NsRecord)
Array of objects (fortinet_com_db_models.PtrRecord)
Array of objects (fortinet_com_db_models.SrvRecord)
Array of objects (fortinet_com_db_models.TxtRecord)
zone_allow_transfer
string
zone_alsonotify_server_ip
Array of strings
zone_dnssec_ready
string
Enum: "disable" "enable"
zone_dnssec_status
string
Enum: "disable" "enable"
zone_domainname
string
zone_id
string
zone_name
string
zone_negative_ttl
string
zone_notify_status
string
Enum: "disable" "enable"
zone_primary_server
string
zone_primary_server_ip
string
zone_primary_server_ip_6
string
zone_responsible_mail
string
zone_serial
string
zone_status
string
Enum: "disable" "enable"
zone_ttl
string
zone_type
string
Enum: "Primary" "Secondary" "FQDN-Generate"

Responses

Request samples

Content type
application/json
{
  • "arecords": [
    ],
  • "cnamerecords": [
    ],
  • "company_id": "0",
  • "dnssec_key": {
    },
  • "dssets": [
    ],
  • "mxrecords": [
    ],
  • "nsrecords": [
    ],
  • "ptrrecords": [
    ],
  • "srvrecords": [
    ],
  • "txtrecords": [
    ],
  • "zone_allow_transfer": "string",
  • "zone_alsonotify_server_ip": [
    ],
  • "zone_dnssec_ready": "",
  • "zone_dnssec_status": "",
  • "zone_domainname": "string",
  • "zone_id": "0",
  • "zone_name": "string",
  • "zone_negative_ttl": "0",
  • "zone_notify_status": "",
  • "zone_primary_server": "string",
  • "zone_primary_server_ip": "string",
  • "zone_primary_server_ip_6": "string",
  • "zone_responsible_mail": "string",
  • "zone_serial": "0",
  • "zone_status": "",
  • "zone_ttl": "0",
  • "zone_type": ""
}

Response samples

Content type
application/json
{
  • "arecords": [
    ],
  • "cnamerecords": [
    ],
  • "company_id": "0",
  • "dnssec_key": {
    },
  • "dssets": [
    ],
  • "mxrecords": [
    ],
  • "nsrecords": [
    ],
  • "ptrrecords": [
    ],
  • "srvrecords": [
    ],
  • "txtrecords": [
    ],
  • "zone_allow_transfer": "string",
  • "zone_alsonotify_server_ip": [
    ],
  • "zone_dnssec_ready": "",
  • "zone_dnssec_status": "",
  • "zone_domainname": "string",
  • "zone_id": "0",
  • "zone_name": "string",
  • "zone_negative_ttl": "0",
  • "zone_notify_status": "",
  • "zone_primary_server": "string",
  • "zone_primary_server_ip": "string",
  • "zone_primary_server_ip_6": "string",
  • "zone_responsible_mail": "string",
  • "zone_serial": "0",
  • "zone_status": "",
  • "zone_ttl": "0",
  • "zone_type": ""
}

BatchRemove Zones by mkeys

BatchRemove Zones by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Application

Get an application list.

Get an application list.

query Parameters
application_name
string
application_ip_type
string
Enum: "IPv4" "IPv6"
application_ip_4
string
application_ip_6
string
application_hc
string
Enum: "disable" "enable"
application_hc_relation
string
Enum: "AND" "OR"
status
number
region_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new application

Create a new application

Request Body schema: application/json
required

The application model

application_hc
string
Enum: "disable" "enable"
application_hc_relation
string
Enum: "AND" "OR"
application_id
string
application_ip_4
string
application_ip_6
string
application_ip_type
string
Enum: "IPv4" "IPv6"
application_name
string
company_id
string
Array of objects (fortinet_com_db_models.HealthCheck)
object (fortinet_com_db_models.Region)
region_id
string
status
string

Responses

Request samples

Content type
application/json
{
  • "application_hc": "",
  • "application_hc_relation": "",
  • "application_id": "0",
  • "application_ip_4": "string",
  • "application_ip_6": "string",
  • "application_ip_type": "",
  • "application_name": "string",
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "region": {
    },
  • "region_id": "0",
  • "status": "0"
}

Response samples

Content type
application/json
"string"

Delete an application.

Delete an application.

path Parameters
id
required
string

The ID of the application

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get an application by Id.

Get an application by Id.

path Parameters
id
required
string

The ID of the application

Responses

Response samples

Content type
application/json
{
  • "application_hc": "",
  • "application_hc_relation": "",
  • "application_id": "0",
  • "application_ip_4": "string",
  • "application_ip_6": "string",
  • "application_ip_type": "",
  • "application_name": "string",
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "region": {
    },
  • "region_id": "0",
  • "status": "0"
}

Update an application.

Update an application.

path Parameters
id
required
string

The ID of the application

Request Body schema: application/json
required

The application model

application_hc
string
Enum: "disable" "enable"
application_hc_relation
string
Enum: "AND" "OR"
application_id
string
application_ip_4
string
application_ip_6
string
application_ip_type
string
Enum: "IPv4" "IPv6"
application_name
string
company_id
string
Array of objects (fortinet_com_db_models.HealthCheck)
object (fortinet_com_db_models.Region)
region_id
string
status
string

Responses

Request samples

Content type
application/json
{
  • "application_hc": "",
  • "application_hc_relation": "",
  • "application_id": "0",
  • "application_ip_4": "string",
  • "application_ip_6": "string",
  • "application_ip_type": "",
  • "application_name": "string",
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "region": {
    },
  • "region_id": "0",
  • "status": "0"
}

Response samples

Content type
application/json
{
  • "application_hc": "",
  • "application_hc_relation": "",
  • "application_id": "0",
  • "application_ip_4": "string",
  • "application_ip_6": "string",
  • "application_ip_type": "",
  • "application_name": "string",
  • "company_id": "0",
  • "healthchecks": [
    ],
  • "region": {
    },
  • "region_id": "0",
  • "status": "0"
}

BatchRemove Applications by mkeys

BatchRemove Applications by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

GatewayStatus

Get a gateway status list.

Get a gateway status list.

query Parameters
gateway_name
string
server_id
number
company_id
number
status
number
bandwidth
number
downstream
number
upstream
number
time_stamp
string
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a gateway status by Id.

Get a gateway status by Id.

path Parameters
id
required
string

The ID of the gateway status

Responses

Response samples

Content type
application/json
{
  • "bandwidth": "0",
  • "company_id": "0",
  • "downstream": "0",
  • "gateway_name": "string",
  • "id": "0",
  • "server_id": "0",
  • "status": "0",
  • "time_stamp": "string",
  • "upstream": "0"
}

Server

Get a server list.

Get a server list.

query Parameters
server_name
string
server_type
string
Enum: "FortiADC-SLB" "Generic-Host" "FortiADC" "FortiGate"
server_ip_type
string
Enum: "IPv4" "IPv6"
server_ip_4
string
server_ip_6
string
server_port
number
server_authtype
string
Enum: "NONE" "TCP-MD5SIG" "Auth-Verify" "Token"
server_authkey
string
server_authname
string
server_token
string
server_api_ver
string
server_sync_ctl
string
Enum: "null" "SD-WAN" "Virtual-Server" "SD-WAN Virtual-Server"
server_hc
string
Enum: "disable" "enable"
server_hc_relation
string
Enum: "AND" "OR"
data_center_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new server

Create a new server

Request Body schema: application/json
required

The server model

company_id
string
data_center_id
string
object (fortinet_com_db_models.DataCenter)
Array of objects (fortinet_com_db_models.GatewayStatus)
Array of objects (fortinet_com_db_models.HealthCheck)
server_api_ver
string
server_authkey
string
server_authname
string
server_authtype
string
Enum: "NONE" "TCP-MD5SIG" "Auth-Verify" "Token"
server_hc
string
Enum: "disable" "enable"
server_hc_relation
string
Enum: "AND" "OR"
server_id
string
server_ip_4
string
server_ip_6
string
server_ip_type
string
Enum: "IPv4" "IPv6"
server_name
string
server_port
string
server_sync_ctl
string
Enum: "null" "SD-WAN" "Virtual-Server" "SD-WAN Virtual-Server"
server_token
string
server_type
string
Enum: "FortiADC-SLB" "Generic-Host" "FortiADC" "FortiGate"
Array of objects (fortinet_com_db_models.VirtualServer)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_id": "0",
  • "datacenter": {
    },
  • "gateways": [
    ],
  • "healthchecks": [
    ],
  • "server_api_ver": "string",
  • "server_authkey": "string",
  • "server_authname": "string",
  • "server_authtype": "",
  • "server_hc": "",
  • "server_hc_relation": "",
  • "server_id": "0",
  • "server_ip_4": "string",
  • "server_ip_6": "string",
  • "server_ip_type": "",
  • "server_name": "string",
  • "server_port": "0",
  • "server_sync_ctl": "",
  • "server_token": "string",
  • "server_type": "",
  • "virtualservers": [
    ]
}

Response samples

Content type
application/json
"string"

Delete a server.

Delete a server.

path Parameters
id
required
string

The ID of the server

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a server by Id.

Get a server by Id.

path Parameters
id
required
string

The ID of the server

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_id": "0",
  • "datacenter": {
    },
  • "gateways": [
    ],
  • "healthchecks": [
    ],
  • "server_api_ver": "string",
  • "server_authkey": "string",
  • "server_authname": "string",
  • "server_authtype": "",
  • "server_hc": "",
  • "server_hc_relation": "",
  • "server_id": "0",
  • "server_ip_4": "string",
  • "server_ip_6": "string",
  • "server_ip_type": "",
  • "server_name": "string",
  • "server_port": "0",
  • "server_sync_ctl": "",
  • "server_token": "string",
  • "server_type": "",
  • "virtualservers": [
    ]
}

Update a server.

Update a server.

path Parameters
id
required
string

The ID of the server

Request Body schema: application/json
required

The server model

company_id
string
data_center_id
string
object (fortinet_com_db_models.DataCenter)
Array of objects (fortinet_com_db_models.GatewayStatus)
Array of objects (fortinet_com_db_models.HealthCheck)
server_api_ver
string
server_authkey
string
server_authname
string
server_authtype
string
Enum: "NONE" "TCP-MD5SIG" "Auth-Verify" "Token"
server_hc
string
Enum: "disable" "enable"
server_hc_relation
string
Enum: "AND" "OR"
server_id
string
server_ip_4
string
server_ip_6
string
server_ip_type
string
Enum: "IPv4" "IPv6"
server_name
string
server_port
string
server_sync_ctl
string
Enum: "null" "SD-WAN" "Virtual-Server" "SD-WAN Virtual-Server"
server_token
string
server_type
string
Enum: "FortiADC-SLB" "Generic-Host" "FortiADC" "FortiGate"
Array of objects (fortinet_com_db_models.VirtualServer)

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_id": "0",
  • "datacenter": {
    },
  • "gateways": [
    ],
  • "healthchecks": [
    ],
  • "server_api_ver": "string",
  • "server_authkey": "string",
  • "server_authname": "string",
  • "server_authtype": "",
  • "server_hc": "",
  • "server_hc_relation": "",
  • "server_id": "0",
  • "server_ip_4": "string",
  • "server_ip_6": "string",
  • "server_ip_type": "",
  • "server_name": "string",
  • "server_port": "0",
  • "server_sync_ctl": "",
  • "server_token": "string",
  • "server_type": "",
  • "virtualservers": [
    ]
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_id": "0",
  • "datacenter": {
    },
  • "gateways": [
    ],
  • "healthchecks": [
    ],
  • "server_api_ver": "string",
  • "server_authkey": "string",
  • "server_authname": "string",
  • "server_authtype": "",
  • "server_hc": "",
  • "server_hc_relation": "",
  • "server_id": "0",
  • "server_ip_4": "string",
  • "server_ip_6": "string",
  • "server_ip_type": "",
  • "server_name": "string",
  • "server_port": "0",
  • "server_sync_ctl": "",
  • "server_token": "string",
  • "server_type": "",
  • "virtualservers": [
    ]
}

BatchRemove Servers by mkeys

BatchRemove Servers by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

ServerStatus

Get a server status list.

Get a server status list.

query Parameters
server_id
number
server_name
string
company_id
number
status
number
cpu_usage
number
memory_usage
number
server_load
number
interval
number
time_stamp
string
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a server status by Id.

Get a server status by Id.

path Parameters
id
required
string

The ID of the server status

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "cpu_usage": "0",
  • "interval": "0",
  • "memory_usage": "0",
  • "server_id": "0",
  • "server_load": "0",
  • "server_name": "string",
  • "status": "0",
  • "time_stamp": "string"
}

Addressgroup

Get an addressgroup list.

Get an addressgroup list.

query Parameters
addressgroup_name
string
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new addressgroup

Create a new addressgroup

Request Body schema: application/json
required

The addressgroup model

addressgroup_id
string
addressgroup_name
string
Array of objects (fortinet_com_db_models.Addressmember)
company_id
string

Responses

Request samples

Content type
application/json
{
  • "addressgroup_id": "0",
  • "addressgroup_name": "string",
  • "addressmembers": [
    ],
  • "company_id": "0"
}

Response samples

Content type
application/json
"string"

Delete an addressgroup.

Delete an addressgroup.

path Parameters
id
required
string

The ID of the addressgroup

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get an addressgroup by Id.

Get an addressgroup by Id.

path Parameters
id
required
string

The ID of the addressgroup

Responses

Response samples

Content type
application/json
{
  • "addressgroup_id": "0",
  • "addressgroup_name": "string",
  • "addressmembers": [
    ],
  • "company_id": "0"
}

Update an addressgroup.

Update an addressgroup.

path Parameters
id
required
string

The ID of the addressgroup

Request Body schema: application/json
required

The addressgroup model

addressgroup_id
string
addressgroup_name
string
Array of objects (fortinet_com_db_models.Addressmember)
company_id
string

Responses

Request samples

Content type
application/json
{
  • "addressgroup_id": "0",
  • "addressgroup_name": "string",
  • "addressmembers": [
    ],
  • "company_id": "0"
}

Response samples

Content type
application/json
{
  • "addressgroup_id": "0",
  • "addressgroup_name": "string",
  • "addressmembers": [
    ],
  • "company_id": "0"
}

BatchRemove Addressgroups by mkeys

BatchRemove Addressgroups by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Addressmember

Get an addressmember list.

Get an addressmember list.

query Parameters
addressmember_type
string
Enum: "AddressNet" "AddressRange"
addressstart_ip
string
addressend_ip
string
addressnet_ip
string
company_id
number
addressgroup_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new addressmember

Create a new addressmember

Request Body schema: application/json
required

The addressmember model

addressend_ip
string
addressgroup_id
string
addressmember_id
string
addressmember_type
string
Enum: "AddressNet" "AddressRange"
addressnet_ip
string
addressstart_ip
string
company_id
string

Responses

Request samples

Content type
application/json
{
  • "addressend_ip": "string",
  • "addressgroup_id": "0",
  • "addressmember_id": "0",
  • "addressmember_type": "",
  • "addressnet_ip": "string",
  • "addressstart_ip": "string",
  • "company_id": "0"
}

Response samples

Content type
application/json
"string"

Delete an addressmember.

Delete an addressmember.

path Parameters
id
required
string

The ID of the addressmember

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get an addressmember by Id.

Get an addressmember by Id.

path Parameters
id
required
string

The ID of the addressmember

Responses

Response samples

Content type
application/json
{
  • "addressend_ip": "string",
  • "addressgroup_id": "0",
  • "addressmember_id": "0",
  • "addressmember_type": "",
  • "addressnet_ip": "string",
  • "addressstart_ip": "string",
  • "company_id": "0"
}

Update an addressmember.

Update an addressmember.

path Parameters
id
required
string

The ID of the addressmember

Request Body schema: application/json
required

The addressmember model

addressend_ip
string
addressgroup_id
string
addressmember_id
string
addressmember_type
string
Enum: "AddressNet" "AddressRange"
addressnet_ip
string
addressstart_ip
string
company_id
string

Responses

Request samples

Content type
application/json
{
  • "addressend_ip": "string",
  • "addressgroup_id": "0",
  • "addressmember_id": "0",
  • "addressmember_type": "",
  • "addressnet_ip": "string",
  • "addressstart_ip": "string",
  • "company_id": "0"
}

Response samples

Content type
application/json
{
  • "addressend_ip": "string",
  • "addressgroup_id": "0",
  • "addressmember_id": "0",
  • "addressmember_type": "",
  • "addressnet_ip": "string",
  • "addressstart_ip": "string",
  • "company_id": "0"
}

BatchRemove Addressmembers by mkeys

BatchRemove Addressmembers by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

DataCenter

Get a data center list.

Get a data center list.

query Parameters
data_center_name
string
data_center_dsp
string
region_id
number
company_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new data center

Create a new data center

Request Body schema: application/json
required

The data center model

company_id
string
data_center_dsp
string
data_center_id
string
data_center_name
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_dsp": "string",
  • "data_center_id": "0",
  • "data_center_name": "string",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a data center.

Delete a data center.

path Parameters
id
required
string

The ID of the data center

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a data center by Id.

Get a data center by Id.

path Parameters
id
required
string

The ID of the data center

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_dsp": "string",
  • "data_center_id": "0",
  • "data_center_name": "string",
  • "region": {
    },
  • "region_id": "0"
}

Update a data center.

Update a data center.

path Parameters
id
required
string

The ID of the data center

Request Body schema: application/json
required

The data center model

company_id
string
data_center_dsp
string
data_center_id
string
data_center_name
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_dsp": "string",
  • "data_center_id": "0",
  • "data_center_name": "string",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "data_center_dsp": "string",
  • "data_center_id": "0",
  • "data_center_name": "string",
  • "region": {
    },
  • "region_id": "0"
}

BatchRemove DataCenters by mkeys

BatchRemove DataCenters by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Region

Get a region list.

Get a region list.

query Parameters
region_short
string
region_dsp
string
region_continent
string
longitude
string
latitude
string
country_id
string
state_id
string
city_id
string
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a region by Id.

Get a region by Id.

path Parameters
id
required
string

The ID of the region

Responses

Response samples

Content type
application/json
{
  • "city_id": "string",
  • "country_id": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "region_continent": "string",
  • "region_dsp": "string",
  • "region_id": "0",
  • "region_short": "string",
  • "state_id": "string"
}

HealthCheck

Get a health check list.

Get a health check list.

query Parameters
health_check_name
string
health_check_type
string
Enum: "icmp" "tcp" "tcp-echo" "http" "https" "dns" "udp"
health_check_interval
number
health_check_timeout
number
health_check_retry
number
health_check_upretry
number
health_check_port
number
health_check_ip_type
string
Enum: "IPv4" "IPv6"
health_check_ip_4
string
health_check_ip_6
string
health_check_http_connect_type
string
Enum: "no_connect" "local_connect" "remote_connect"
health_check_http_method_type
string
Enum: "http_get" "http_head"
health_check_hostname
string
health_check_remote_host
string
health_check_remote_port
number
health_check_remote_username
string
health_check_remote_password
string
health_check_http_sendstring
string
health_check_http_receivestring
string
health_check_http_statuscode
number
health_check_http_matchtype
string
Enum: "match_string" "match_status" "match_all"
health_check_dns_domainname
string
health_check_dns_ip_type
string
Enum: "IPv4" "IPv6"
health_check_dnsip_4
string
health_check_dnsip_6
string
health_check_username
string
health_check_password
string
health_check_radius_password_type
number
health_check_radius_secretkey
string
health_check_radius_nasip
string
health_check_folder
string
health_check_file
string
health_check_snmp_cpu
number
health_check_snmp_memory
number
health_check_snmp_disk
number
health_check_snmp_agent_type
number
health_check_snmp_community
string
health_check_snmp_version
number
health_check_mysql_type
string
company_id
number
health_check_ssl_version
string
health_check_ssl_ciphers
string
health_check_local_cert
string
conf_not_permit
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new health check

Create a new health check

Request Body schema: application/json
required

The health check model

company_id
string
conf_not_permit
string
health_check_dns_domainname
string
health_check_dns_ip_type
string
Enum: "IPv4" "IPv6"
health_check_dnsip_4
string
health_check_dnsip_6
string
health_check_file
string
health_check_folder
string
health_check_hostname
string
health_check_http_connect_type
string
Enum: "no_connect" "local_connect" "remote_connect"
health_check_http_matchtype
string
Enum: "match_string" "match_status" "match_all"
health_check_http_method_type
string
Enum: "http_get" "http_head"
health_check_http_receivestring
string
health_check_http_sendstring
string
health_check_http_statuscode
string
health_check_id
string
health_check_interval
string
health_check_ip_4
string
health_check_ip_6
string
health_check_ip_type
string
Enum: "IPv4" "IPv6"
health_check_local_cert
string
health_check_mysql_type
string
health_check_name
string
health_check_password
string
health_check_port
string
health_check_radius_nasip
string
health_check_radius_password_type
string
health_check_radius_secretkey
string
health_check_remote_host
string
health_check_remote_password
string
health_check_remote_port
string
health_check_remote_username
string
health_check_retry
string
health_check_snmp_agent_type
string
health_check_snmp_community
string
health_check_snmp_cpu
string
health_check_snmp_disk
string
health_check_snmp_memory
string
health_check_snmp_version
string
health_check_ssl_ciphers
string
health_check_ssl_version
string
health_check_timeout
string
health_check_type
string
Enum: "icmp" "tcp-echo" "tcp" "http" "https" "dns" "udp"
health_check_upretry
string
health_check_username
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "conf_not_permit": "0",
  • "health_check_dns_domainname": "string",
  • "health_check_dns_ip_type": "",
  • "health_check_dnsip_4": "string",
  • "health_check_dnsip_6": "string",
  • "health_check_file": "string",
  • "health_check_folder": "string",
  • "health_check_hostname": "string",
  • "health_check_http_connect_type": "",
  • "health_check_http_matchtype": "",
  • "health_check_http_method_type": "",
  • "health_check_http_receivestring": "string",
  • "health_check_http_sendstring": "string",
  • "health_check_http_statuscode": "0",
  • "health_check_id": "0",
  • "health_check_interval": "0",
  • "health_check_ip_4": "string",
  • "health_check_ip_6": "string",
  • "health_check_ip_type": "",
  • "health_check_local_cert": "string",
  • "health_check_mysql_type": "string",
  • "health_check_name": "string",
  • "health_check_password": "string",
  • "health_check_port": "0",
  • "health_check_radius_nasip": "string",
  • "health_check_radius_password_type": "0",
  • "health_check_radius_secretkey": "string",
  • "health_check_remote_host": "string",
  • "health_check_remote_password": "string",
  • "health_check_remote_port": "0",
  • "health_check_remote_username": "string",
  • "health_check_retry": "0",
  • "health_check_snmp_agent_type": "0",
  • "health_check_snmp_community": "string",
  • "health_check_snmp_cpu": "0",
  • "health_check_snmp_disk": "0",
  • "health_check_snmp_memory": "0",
  • "health_check_snmp_version": "0",
  • "health_check_ssl_ciphers": "string",
  • "health_check_ssl_version": "string",
  • "health_check_timeout": "0",
  • "health_check_type": "",
  • "health_check_upretry": "0",
  • "health_check_username": "string"
}

Response samples

Content type
application/json
"string"

Delete a health check.

Delete a health check.

path Parameters
id
required
string

The ID of the health check

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a health check by Id.

Get a health check by Id.

path Parameters
id
required
string

The ID of the health check

Responses

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "conf_not_permit": "0",
  • "health_check_dns_domainname": "string",
  • "health_check_dns_ip_type": "",
  • "health_check_dnsip_4": "string",
  • "health_check_dnsip_6": "string",
  • "health_check_file": "string",
  • "health_check_folder": "string",
  • "health_check_hostname": "string",
  • "health_check_http_connect_type": "",
  • "health_check_http_matchtype": "",
  • "health_check_http_method_type": "",
  • "health_check_http_receivestring": "string",
  • "health_check_http_sendstring": "string",
  • "health_check_http_statuscode": "0",
  • "health_check_id": "0",
  • "health_check_interval": "0",
  • "health_check_ip_4": "string",
  • "health_check_ip_6": "string",
  • "health_check_ip_type": "",
  • "health_check_local_cert": "string",
  • "health_check_mysql_type": "string",
  • "health_check_name": "string",
  • "health_check_password": "string",
  • "health_check_port": "0",
  • "health_check_radius_nasip": "string",
  • "health_check_radius_password_type": "0",
  • "health_check_radius_secretkey": "string",
  • "health_check_remote_host": "string",
  • "health_check_remote_password": "string",
  • "health_check_remote_port": "0",
  • "health_check_remote_username": "string",
  • "health_check_retry": "0",
  • "health_check_snmp_agent_type": "0",
  • "health_check_snmp_community": "string",
  • "health_check_snmp_cpu": "0",
  • "health_check_snmp_disk": "0",
  • "health_check_snmp_memory": "0",
  • "health_check_snmp_version": "0",
  • "health_check_ssl_ciphers": "string",
  • "health_check_ssl_version": "string",
  • "health_check_timeout": "0",
  • "health_check_type": "",
  • "health_check_upretry": "0",
  • "health_check_username": "string"
}

Update a health check.

Update a health check.

path Parameters
id
required
string

The ID of the health check

Request Body schema: application/json
required

The health check model

company_id
string
conf_not_permit
string
health_check_dns_domainname
string
health_check_dns_ip_type
string
Enum: "IPv4" "IPv6"
health_check_dnsip_4
string
health_check_dnsip_6
string
health_check_file
string
health_check_folder
string
health_check_hostname
string
health_check_http_connect_type
string
Enum: "no_connect" "local_connect" "remote_connect"
health_check_http_matchtype
string
Enum: "match_string" "match_status" "match_all"
health_check_http_method_type
string
Enum: "http_get" "http_head"
health_check_http_receivestring
string
health_check_http_sendstring
string
health_check_http_statuscode
string
health_check_id
string
health_check_interval
string
health_check_ip_4
string
health_check_ip_6
string
health_check_ip_type
string
Enum: "IPv4" "IPv6"
health_check_local_cert
string
health_check_mysql_type
string
health_check_name
string
health_check_password
string
health_check_port
string
health_check_radius_nasip
string
health_check_radius_password_type
string
health_check_radius_secretkey
string
health_check_remote_host
string
health_check_remote_password
string
health_check_remote_port
string
health_check_remote_username
string
health_check_retry
string
health_check_snmp_agent_type
string
health_check_snmp_community
string
health_check_snmp_cpu
string
health_check_snmp_disk
string
health_check_snmp_memory
string
health_check_snmp_version
string
health_check_ssl_ciphers
string
health_check_ssl_version
string
health_check_timeout
string
health_check_type
string
Enum: "icmp" "tcp-echo" "tcp" "http" "https" "dns" "udp"
health_check_upretry
string
health_check_username
string

Responses

Request samples

Content type
application/json
{
  • "company_id": "0",
  • "conf_not_permit": "0",
  • "health_check_dns_domainname": "string",
  • "health_check_dns_ip_type": "",
  • "health_check_dnsip_4": "string",
  • "health_check_dnsip_6": "string",
  • "health_check_file": "string",
  • "health_check_folder": "string",
  • "health_check_hostname": "string",
  • "health_check_http_connect_type": "",
  • "health_check_http_matchtype": "",
  • "health_check_http_method_type": "",
  • "health_check_http_receivestring": "string",
  • "health_check_http_sendstring": "string",
  • "health_check_http_statuscode": "0",
  • "health_check_id": "0",
  • "health_check_interval": "0",
  • "health_check_ip_4": "string",
  • "health_check_ip_6": "string",
  • "health_check_ip_type": "",
  • "health_check_local_cert": "string",
  • "health_check_mysql_type": "string",
  • "health_check_name": "string",
  • "health_check_password": "string",
  • "health_check_port": "0",
  • "health_check_radius_nasip": "string",
  • "health_check_radius_password_type": "0",
  • "health_check_radius_secretkey": "string",
  • "health_check_remote_host": "string",
  • "health_check_remote_password": "string",
  • "health_check_remote_port": "0",
  • "health_check_remote_username": "string",
  • "health_check_retry": "0",
  • "health_check_snmp_agent_type": "0",
  • "health_check_snmp_community": "string",
  • "health_check_snmp_cpu": "0",
  • "health_check_snmp_disk": "0",
  • "health_check_snmp_memory": "0",
  • "health_check_snmp_version": "0",
  • "health_check_ssl_ciphers": "string",
  • "health_check_ssl_version": "string",
  • "health_check_timeout": "0",
  • "health_check_type": "",
  • "health_check_upretry": "0",
  • "health_check_username": "string"
}

Response samples

Content type
application/json
{
  • "company_id": "0",
  • "conf_not_permit": "0",
  • "health_check_dns_domainname": "string",
  • "health_check_dns_ip_type": "",
  • "health_check_dnsip_4": "string",
  • "health_check_dnsip_6": "string",
  • "health_check_file": "string",
  • "health_check_folder": "string",
  • "health_check_hostname": "string",
  • "health_check_http_connect_type": "",
  • "health_check_http_matchtype": "",
  • "health_check_http_method_type": "",
  • "health_check_http_receivestring": "string",
  • "health_check_http_sendstring": "string",
  • "health_check_http_statuscode": "0",
  • "health_check_id": "0",
  • "health_check_interval": "0",
  • "health_check_ip_4": "string",
  • "health_check_ip_6": "string",
  • "health_check_ip_type": "",
  • "health_check_local_cert": "string",
  • "health_check_mysql_type": "string",
  • "health_check_name": "string",
  • "health_check_password": "string",
  • "health_check_port": "0",
  • "health_check_radius_nasip": "string",
  • "health_check_radius_password_type": "0",
  • "health_check_radius_secretkey": "string",
  • "health_check_remote_host": "string",
  • "health_check_remote_password": "string",
  • "health_check_remote_port": "0",
  • "health_check_remote_username": "string",
  • "health_check_retry": "0",
  • "health_check_snmp_agent_type": "0",
  • "health_check_snmp_community": "string",
  • "health_check_snmp_cpu": "0",
  • "health_check_snmp_disk": "0",
  • "health_check_snmp_memory": "0",
  • "health_check_snmp_version": "0",
  • "health_check_ssl_ciphers": "string",
  • "health_check_ssl_version": "string",
  • "health_check_timeout": "0",
  • "health_check_type": "",
  • "health_check_upretry": "0",
  • "health_check_username": "string"
}

BatchRemove HealthChecks by mkeys

BatchRemove HealthChecks by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

Account

Get an account list.

Get an account list.

query Parameters
account_name
string
account_email
string
dnsserver_id
number
aws_customer_id
string
aws_trial
number
invalid_days
number
subscribe_maint
string
Enum: "disable" "enable"
subscribe_config
string
Enum: "disable" "enable"
subscribe_system
string
Enum: "disable" "enable"
subscribe_connector
string
Enum: "disable" "enable"
subscribe_hc
string
Enum: "disable" "enable"
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an account by Id.

Get an account by Id.

path Parameters
id
required
string

The ID of the account

Responses

Response samples

Content type
application/json
{
  • "account_email": "string",
  • "account_id": "0",
  • "account_name": "string",
  • "accountusers": [
    ],
  • "aws_customer_id": "string",
  • "aws_trial": 0,
  • "companies": [
    ],
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "invalid_days": 0,
  • "licenses": [
    ],
  • "subscribe_config": "",
  • "subscribe_connector": "",
  • "subscribe_hc": "",
  • "subscribe_maint": "",
  • "subscribe_system": ""
}

AccountUser

Get an account user list.

Get an account user list.

query Parameters
account_user_name
string
account_user_email
string
is_iam_user
boolean
account_id
number
forticare_user_id
number
permission
string
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an account user by Id.

Get an account user by Id.

path Parameters
id
required
string

The ID of the account user

Responses

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "account_user_email": "string",
  • "account_user_id": "0",
  • "account_user_name": "string",
  • "companies": [
    ],
  • "forticare_user_id": "0",
  • "is_iam_user": true,
  • "permission": "string"
}

Company

Get a company list.

Get a company list.

query Parameters
company_name
string
company_address
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
company_description
string
region_id
number
dnsserver_id
number
account_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new company

Create a new company

Request Body schema: application/json
required

The company model

account_id
string
Array of objects (fortinet_com_db_models.AccountUser)
company_address
string
company_description
string
company_id
string
company_name
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
object (fortinet_com_db_models.Dnsserver)
dnsserver_id
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a company.

Delete a company.

path Parameters
id
required
string

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a company by Id.

Get a company by Id.

path Parameters
id
required
string

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Update a company.

Update a company.

path Parameters
id
required
string

The ID of the company

Request Body schema: application/json
required

The company model

account_id
string
Array of objects (fortinet_com_db_models.AccountUser)
company_address
string
company_description
string
company_id
string
company_name
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
object (fortinet_com_db_models.Dnsserver)
dnsserver_id
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

BatchRemove Companies by mkeys

BatchRemove Companies by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}

License

Get a license list.

Get a license list.

query Parameters
license_serial_number
string
contract_number
string
quantity
number
license_sku
string
license_type
string
license_start_date
string
license_end_date
string
expired_handle
boolean
account_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a license by Id.

Get a license by Id.

path Parameters
id
required
string

The ID of the license

Responses

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "contract_number": "string",
  • "expired_handle": true,
  • "license_end_date": "string",
  • "license_id": "0",
  • "license_serial_number": "string",
  • "license_sku": "string",
  • "license_start_date": "string",
  • "license_type": "string",
  • "quantity": 0
}

LicenseStatus

Get a license status list.

Get a license status list.

query Parameters
type
string
Enum: "data-center" "location" "virtual-server" "server" "pool" "fqdn" "zone" "company" "health-check" "syslog" "application" "addressgroup"
status
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a license status by Id.

Get a license status by Id.

path Parameters
id
required
string

The ID of the license status

Responses

Response samples

Content type
application/json
{
  • "id": "0",
  • "status": "0",
  • "type": ""
}

Company

Get a company list.

Get a company list.

query Parameters
company_name
string
company_address
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
company_description
string
region_id
number
dnsserver_id
number
account_id
number
sort
string

This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2

last_id
number

The offset of the current model based on its ID.

limit
string

The number of records to be returned.

order
string

The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.

fields
string

The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new company

Create a new company

Request Body schema: application/json
required

The company model

account_id
string
Array of objects (fortinet_com_db_models.AccountUser)
company_address
string
company_description
string
company_id
string
company_name
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
object (fortinet_com_db_models.Dnsserver)
dnsserver_id
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
"string"

Delete a company.

Delete a company.

path Parameters
id
required
string

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "error": "error message"
}

Get a company by Id.

Get a company by Id.

path Parameters
id
required
string

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Update a company.

Update a company.

path Parameters
id
required
string

The ID of the company

Request Body schema: application/json
required

The company model

account_id
string
Array of objects (fortinet_com_db_models.AccountUser)
company_address
string
company_description
string
company_id
string
company_name
string
company_phone
string
company_type
string
Enum: "Regular" "OneClick" "Other"
object (fortinet_com_db_models.Dnsserver)
dnsserver_id
string
object (fortinet_com_db_models.Region)
region_id
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

Response samples

Content type
application/json
{
  • "account_id": "0",
  • "accountusers": [
    ],
  • "company_address": "string",
  • "company_description": "string",
  • "company_id": "0",
  • "company_name": "string",
  • "company_phone": "string",
  • "company_type": "",
  • "dnsserver": {
    },
  • "dnsserver_id": "0",
  • "region": {
    },
  • "region_id": "0"
}

BatchRemove Companies by mkeys

BatchRemove Companies by mkeys

Request Body schema: application/json
required

mkeys for the batch removal

mkeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "mkeys": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "error message"
}