OpenAPI Fotbo.com (Specification 1.0.5)

Download OpenAPI specification:Download

Introduction

Welcome to the API documentation for Fotbo.com services. This API is documented in OpenAPI format. Explore the following sections to gain comprehensive insights into the functionalities and capabilities offered by our platform. Whether you are interested in user registration, account management, billing details, or the configuration of virtualized resources, this documentation provides detailed information and examples to facilitate your interaction with our services.

Authentication Billing offers forms of authentication - API Key. Authentication tokens are used instead of passwords and are handy when using Fotbo API from scripts or other software that you write and interacts with Fotbo. You can make simple GET, POST, PUT or DELETE HTTP requests by using curl. Make sure you include the authorization header as curl parameter:

  • 'Authorization: Token {Token}'

    Sections:

    • Instances (VPS): Dive into the world of Virtual Private Servers (VPS), covering instance creation, management, and configuration.

    • Load balancers: Understand load balancing functionalities for efficient traffic distribution and high availability.

    • Networks (VPC): Explore Virtual Private Cloud (VPC) features, including network creation, subnet configuration, and security settings.

    • Routers: Manage and optimize routing settings for your infrastructure.

    • Zones (DNS): Gain insights into Domain Name System (DNS) functionalities, managing DNS zones and domain settings.

    • Security groups: Define and apply security group rules to control inbound and outbound traffic.

    • Floating IPs: Allocate, associate, and manage floating IP addresses for flexible network configurations.

    • SSH Keys: Manage Secure Shell (SSH) keys for secure access to instances and services.

    • My images: Handle custom images, including creation, upload, and management for efficient deployment.

    • Billing: Access information on billing functionalities, including invoice management, payment methods, and billing history.

    • User: Explore user management, profile customization, and authentication options to tailor your experience.

    • Clients: Access features related to client management, usage statistics, and client experience optimization.

    • Tickets: Utilize support ticket management features, from creation to resolution.

    • Notifications: Configure notification preferences to stay informed about important events and updates.

    Explore the detailed descriptions, endpoints, features, and examples provided in each section to make the most of our hosting services. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Instances (VPS)

The "Instances (VPS)" section covers everything related to Virtual Private Servers (VPS). Users can create, manage, and monitor their instances, customize configurations, and explore features for efficient virtualization. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Get Instance list

Host: https://api.fotbo.com

Retrieve a list of OpenStack instances associated with the user's account. Get a list of information about instances when they don't exist yet.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "previous": null,
  • "objects": [
    ],
  • "totalCount": 0,
  • "pageNo": "string",
  • "permissions": {
    },
  • "filter_options": {
    },
  • "operations": [ ]
}

Create Instances

Host: https://api.fotbo.com

Create Instances. You can specify SSH key or password. It is recommended to use a complex password of 16 characters or more, of different case, including numbers and special characters. You can also specify the number of instances to create.

Authorizations:
apikey header authorization
Request Body schema: application/json
required
object
client
required
integer
flavor
required
string
name
required
string
nics
required
Array of strings
region
required
string
root_password
required
string
ssh_keys
required
string
number_of_instances
required
integer
user_data
required
string

Responses

Request samples

Content type
application/json
{
  • "boot_source": {
    },
  • "client": "{client_id}",
  • "flavor": "{country_name}-{flavor_id}",
  • "name": "{name}",
  • "nics": [
    ],
  • "region": "{country_name}",
  • "root_password": "{root_password}",
  • "ssh_keys": "[{id1}]",
  • "number_of_instances": "{number_of_instances}",
  • "user_data": ""
}

Response samples

Content type
application/json
{
  • "name": {
    },
  • "flavor": {
    },
  • "region": {
    },
  • "availability_zone": null,
  • "operation_id": {
    }
}

Get create Instance options

Host: https://api.fotbo.com

Retrieve options for creating a new instance. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization
query Parameters
image
string
region
string

Responses

Response samples

Content type
application/json
{
  • "bootSources": {
    },
  • "flavor": [
    ],
  • "ssh_key": [
    ],
  • "nics": [
    ],
  • "availability_zones": [ ],
  • "cinder_az": [ ],
  • "enable_volumes": false,
  • "enable_snapshots": true,
  • "hide_volume_az": true,
  • "region": [
    ],
  • "selected_region": "Staging",
  • "client": {
    }
}

Reboot Instance

Host: https://api.fotbo.com

Initiate a reboot for the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

List Rescue Instance

Host: https://api.fotbo.com

List recovery options for the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "image": {
    },
  • "instance": {
    }
}

Rescue Instance

Host: https://api.fotbo.com

Activate rescue mode for the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
image
required
string
root_password
required
string

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "root_password": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Shelve Instance

Host: https://api.fotbo.com

Shelve the specified instance, saving its state for later use.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Start Instance

Host: https://api.fotbo.com

Start the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Stop Instance

Host: https://api.fotbo.com

Stop the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Unrescue Instance

Host: https://api.fotbo.com

Deactivate rescue ISO-mode for the specified instance. Umount ISO-image ande reboot.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Select Instance for Rebuild

Host: https://api.fotbo.com

Select the specified instance for Rebuild. In this case, all current data on instance will be destroyed.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "bootSources": {
    },
  • "instance": {
    },
  • "ssh_keys": [
    ]
}

Rebuild instance

Host: https://api.fotbo.com

Rebuild the specified instance. In this case, all current data on instance will be destroyed.

Authorizations:
apikey header authorization
Request Body schema: application/json
image
required
string
ssh_keys
required
string

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "ssh_keys": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Rename Instance

Host: https://api.fotbo.com

Change the name of the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "netbsd-3333"
}

Response samples

Content type
application/json
{
  • "detail": "Renamed"
}

Resize Instance

Host: https://api.fotbo.com

Change the size of the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
flavor
required
string

Responses

Request samples

Content type
application/json
{
  • "flavor": "{country_name}-{flavor_id}"
}

Response samples

Content type
application/json
{
  • "detail": "Instance resize started successfully"
}

Get Resize Options

Host: https://api.fotbo.com

Retrieve available options for resizing the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "flavors": [
    ],
  • "instance": {
    }
}

Traffic Data

Host: https://api.fotbo.com

Retrieve traffic data for the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "cycle_traffic": [ ],
  • "month_traffic": [ ]
}

Unshelve Instance

Host: https://api.fotbo.com

Unshelve the specified instance, restoring its state.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

List booting from ISO

Host: https://api.fotbo.com

View a list of booting or launching an instance from an ISO image.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "image": {
    },
  • "instance": {
    }
}

Boot from iso

Authorizations:
apikey header authorization
Request Body schema: application/json
image
required
string

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Change Instance Password

Host: https://api.fotbo.com

Change the password for the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Dissociate IP Create Options

Host: https://api.fotbo.com

Retrieve options for dissociating an IP from the specified instance. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

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

Get Console URL

Host: https://api.fotbo.com

Retrieve the console URL for the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "remote_console": {
    }
}

Get Add IP Options

Host: https://api.fotbo.com

Retrieve options for adding an IP to the specified instance. No ports found for instance

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ],
  • "ports": [
    ]
}

Get Associate IP Create Options

Host: https://api.fotbo.com

Retrieve options for associating an IP with the specified instance. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Confirm Resize

Host: https://api.fotbo.com

Confirm the resizing of the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "Resize confirmed"
}

Get Console Output

Host: https://api.fotbo.com

Retrieve the console output for the specified instance.

Authorizations:
apikey header authorization
query Parameters
length
string

Responses

Response samples

Content type
application/json
{
  • "console_text": "",
  • "length": 30
}

Instance Measures

Host: https://api.fotbo.com

Retrieve measures for the specified instance.

Authorizations:
apikey header authorization
query Parameters
hours
string
metric
string

Responses

Response samples

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

Add Floating IP

Host: https://api.fotbo.com

Add a floating IP to the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
fixed_ip
required
string
floating_ip
required
string

Responses

Request samples

Content type
application/json
{
  • "fixed_ip": "{fixed_ip}",
  • "floating_ip": "{floating_ip}"
}

Response samples

Content type
application/json
{
  • "detail": "Floating ip associated"
}

Add Port Options

Host: https://api.fotbo.com

Retrieve options for adding a port to the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ],
  • "project_id": "73aa943377f14b5bbef095786cd9635b"
}

Create Backup

Host: https://api.fotbo.com

Create a backup for the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
backup_name
required
string
backup_type
required
string
rotation
required
integer

Responses

Request samples

Content type
application/json
{
  • "backup_name": "{name_image}",
  • "backup_type": "manual",
  • "rotation": 1
}

Response samples

Content type
application/json
{
  • "detail": "Backup for instance netbsd-3333 was scheduled for creation"
}

Get Backup Price

Host: https://api.fotbo.com

Retrieve the price for creating a backup of the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.0007 / hour<br>\nor €0.50 / month"
}

Get Instance Backups and Backup Schedules

Host: https://api.fotbo.com

Retrieve information about backups and backup schedules for the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "backups": [
    ],
  • "schedules": [
    ]
}

Create Snapshot

Host: https://api.fotbo.com

Create a snapshot for the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "{name}"
}

Response samples

Content type
application/json
{
  • "image_uuid": "ede0eb63-5c8f-4c9b-95ab-c1a167cb8143"
}

Get Snapshot Price per Cycle

Host: https://api.fotbo.com

Retrieve the price per cycle for creating a snapshot of the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.0007 / hour<br>\nor €0.50 / month",
  • "estimated_cost_display_reseller": null
}

Remove Floating IP

Host: https://api.fotbo.com

Remove a floating IP from the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
ip
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "{floating_ip}"
}

Response samples

Content type
application/json
{
  • "detail": "Floating ip dissociated"
}

Instance Actions

Host: https://api.fotbo.com

Retrieve a list of actions available for the specified instance.

Authorizations:
apikey header authorization
query Parameters
limit
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "hasMore": true,
  • "objects": [
    ]
}

Create Associate Security Group

Host: https://api.fotbo.com

Associate a security group with the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
group
required
string

Responses

Request samples

Content type
application/json
{
  • "group": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Get Associate Security Group Options

Host: https://api.fotbo.com

Retrieve options for associating a security group with the specified instance. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

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

Dissociate Security Group

Host: https://api.fotbo.com

Dissociate a security group from the specified instance.

Authorizations:
apikey header authorization
Request Body schema: application/json
group
required
string

Responses

Request samples

Content type
application/json
{
  • "group": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

List Security Groups

Host: https://api.fotbo.com

Retrieve a list of security groups associated with the specified instance.

Authorizations:
apikey header authorization

Responses

Response samples

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

Delete instance

Host: https://api.fotbo.com

Delete a specific instance, identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
null

Get Instance Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific OpenStack instance identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "access_ip": "2a13:4ac0:4:0:f816:3eff:fe72:1524",
  • "allowed_actions": [
    ],
  • "availability_zone": "nova",
  • "booted_from_iso": false,
  • "client": {
    },
  • "created": "2023-11-30T12:41:48+02:00",
  • "current_cycle_traffic": 0,
  • "current_month_traffic": 0,
  • "description": null,
  • "display_status": "Running",
  • "display_task": null,
  • "flavor": {
    },
  • "hostId": "d4e0893dc4b0aac68503e0df8e6ea38ab0caac213fb331184801d7d8",
  • "host_name": "worker-node01-nl",
  • "id": "{instance_id}",
  • "image": null,
  • "locked": false,
  • "name": "{name_instance}",
  • "net_details": {
    },
  • "project": "73aa943377f14b5bbef095786cd9635b",
  • "region": "{country_name}",
  • "region_obj": {
    },
  • "status": "active",
  • "storage_details": {
    },
  • "traffic_type": "all",
  • "uuid": "{instance_id}"
}

Get Instance Price

Host: https://api.fotbo.com

Retrieve the price for creating a new instance.

Authorizations:
apikey header authorization
query Parameters
client_id
string
flavor_id
string
network_ids
string
region
string

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.0069 / hour<br>\nor €5.00 / month"
}

Instance Permissions

Host: https://api.fotbo.com

Retrieve permissions related to instances.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "instances.abort-migrate": true,
  • "instances.add_floating_ip": true,
  • "instances.associate_security_group": true,
  • "instances.attach-volume": true,
  • "instances.attach_port": true,
  • "instances.boot_from_iso": true,
  • "instances.change-password": true,
  • "instances.confirm-resize": true,
  • "instances.create": true,
  • "instances.create_backup": true,
  • "instances.create_snapshot": true,
  • "instances.destroy": true,
  • "instances.detach_port": true,
  • "instances.detach_volume": true,
  • "instances.dissociate_security_group": true,
  • "instances.list": true,
  • "instances.lock": true,
  • "instances.migrate": true,
  • "instances.move": true,
  • "instances.reboot": true,
  • "instances.rebuild": true,
  • "instances.remove_floating_ip": true,
  • "instances.rename": true,
  • "instances.rescue": true,
  • "instances.reset-state": true,
  • "instances.resize": true,
  • "instances.resume": true,
  • "instances.retrieve": true,
  • "instances.revert-resize": true,
  • "instances.shelve": true,
  • "instances.start": true,
  • "instances.stop": true,
  • "instances.suspend": true,
  • "instances.unlock": true,
  • "instances.unrescue": true,
  • "instances.unshelve": true
}

Add Ports

Host: https://api.fotbo.com

Retrieve a list of ports associated with the user's account. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
attach_to
required
string
device_id
required
string
device_owner
required
string
required
Array of objects
network
required
string
project
required
string
region
required
string
subnet
required
string

Responses

Request samples

Content type
application/json
{
  • "attach_to": "string",
  • "device_id": "string",
  • "device_owner": "string",
  • "fixed_ips": [
    ],
  • "network": "string",
  • "project": "string",
  • "region": "string",
  • "subnet": "string"
}

Response samples

Content type
application/json
{
  • "name": null,
  • "admin_state_up": true,
  • "port_security_enabled": true,
  • "fixed_ips": [ ],
  • "region": "string",
  • "attach_to": "string",
  • "project": "string",
  • "host_id": null,
  • "vnic_type": null,
  • "auto_add_security_group": true,
  • "created_at": null,
  • "description": null,
  • "device_id": "string",
  • "device_owner": "string",
  • "mac_address": null,
  • "status": null,
  • "network": "string"
}

Add IP to Port

Host: https://api.fotbo.com

Add an IP address to the specified port in VPS. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
append_ip
required
boolean
device_id
required
string
device_owner
required
string
required
Array of objects
port
required
string
region
required
string
subnet
required
string

Responses

Request samples

Content type
application/json
{
  • "append_ip": true,
  • "device_id": "{instance_id}",
  • "device_owner": "compute:nova",
  • "fixed_ips": [
    ],
  • "port": "{ports_id}",
  • "region": "{country_name}",
  • "subnet": "{id_subnet}"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Automatic IP Addition to Port

Host: https://api.fotbo.com

Automatically add IPs to the specified port in VPS.

Authorizations:
apikey header authorization
Request Body schema: application/json
required
Array of objects
region
required
string

Responses

Request samples

Content type
application/json
{
  • "fixed_ips": [
    ],
  • "region": "{country_name}"
}

Response samples

Content type
application/json
{
  • "detail": "IP(s) added"
}

Remove IP from Port

Host: https://api.fotbo.com

Remove IP from the specified port in VPS.

Authorizations:
apikey header authorization
Request Body schema: application/json
required
Array of objects
region
required
string

Responses

Request samples

Content type
application/json
{
  • "fixed_ips": [
    ],
  • "region": "{country_name}"
}

Response samples

Content type
application/json
{
  • "detail": "IP removed"
}

List Regions

Host: https://api.fotbo.com

Retrieve a list of regions available.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "next": null,
  • "objects": [
    ],
  • "pageNo": 1,
  • "previous": null,
  • "totalCount": 2
}

Create Backup schedules

Host: https://api.fotbo.com

Access and manage OpenStack backup options and configurations.

Authorizations:
apikey header authorization
Request Body schema: application/json
backup_name
required
string
backup_type
required
string
day
integer
instance
required
string
rotation
required
integer
run_at
required
null

Responses

Request samples

Content type
application/json
{
  • "backup_name": "{name_image}",
  • "backup_type": "weekly",
  • "day": 0,
  • "instance": "{instance_id}",
  • "rotation": 1,
  • "run_at": null
}

Response samples

Content type
application/json
{
  • "backup_name": "{name_image}",
  • "backup_type": "weekly",
  • "day": 0,
  • "hour": 6,
  • "id": 181141,
  • "instance": "{instance_id}",
  • "rotation": 1,
  • "run_at": "2023-12-04T08:00:00.855745+02:00"
}

Load balancers

The "Load balancers" section offers insights into load balancing functionalities. Users can configure and manage load balancers, distribute traffic efficiently, and ensure high availability for their applications. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Get Load Balancer Options

Host: https://api.fotbo.com

Retrieve options for creating a new LBAAS listener within the Load Balancer as a Service context. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{
  • "availability_zones": [ ],
  • "certificates": [ ],
  • "flavors": [ ],
  • "listener_protocols": [
    ],
  • "monitor_http_methods": {
    },
  • "monitor_types": {
    },
  • "pool_algorithms": {
    },
  • "pool_protocols": [
    ],
  • "pool_supported_algorithms": [
    ],
  • "protocols": {
    },
  • "session_persistence_types": {
    },
  • "subnets": [
    ]
}

List Load Balancer

Host: https://api.fotbo.com

Access LBAAS load balancers within the Load Balancer as a Service context.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string
region
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "previous": null,
  • "objects": [ ],
  • "totalCount": 0,
  • "pageNo": 0,
  • "onePage": true,
  • "disableCreate": true,
  • "permissions": { }
}

Load Balancer Policies

Host: https://api.fotbo.com

Access L7 policies within the Load Balancer as a Service context.

Authorizations:
apikey header authorization
query Parameters
listener_id
string
page
string
region
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "objects": [ ],
  • "onePage": true,
  • "pageNo": 1,
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 0
}

Get LBAAS Listeners

Host: https://api.fotbo.com

Access LBAAS listeners within the Load Balancer as a Service context.

Authorizations:
apikey header authorization
query Parameters
loadbalancer_id
string
region
string

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "objects": [
    ],
  • "onePage": true,
  • "pageNo": 1,
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 1
}

Create Listeners for Load Balancer

Host: https://api.fotbo.com

You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
query Parameters
region
string
Request Body schema: application/json
required
object
loadbalancer_id
required
string
required
object
required
object
pool_members
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "listener_details": {
    },
  • "loadbalancer_id": "{load-balancer_id}",
  • "monitor_details": {
    },
  • "pool_details": {
    },
  • "pool_members": [ ]
}

Response samples

Content type
application/json
{
  • "detail": "Unable to create listener, please contact support"
}

Delete LBAAS listener

Host: https://api.fotbo.com

Delete a specific LBAAS listener identified by its unique ID. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
query Parameters
loadbalancer_id
string
region
string

Responses

Response samples

Content type
application/json
{
  • "detail": "Error when deleting listener"
}

Get LBAAS Listener Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific LBAAS listener identified by its unique ID.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "connection_limit": -1,
  • "created_at": "2023-11-28T09:52:26",
  • "default_pool_id": "{lbaas-pools}",
  • "description": "1111122",
  • "id": "{lbaas-listeners_id}",
  • "insert_headers": { },
  • "l7policies": [ ],
  • "name": "{lbaas_name}",
  • "operating_status": "ONLINE",
  • "protocol": "TCP",
  • "protocol_port": 11111,
  • "provisioning_status": "ACTIVE",
  • "tags": [ ],
  • "timeout_client_data": 50000,
  • "timeout_member_connect": 5000,
  • "timeout_member_data": 50001,
  • "timeout_tcp_inspect": 0,
  • "tls_ciphers": null,
  • "updated_at": "2023-11-29T14:47:42"
}

Change LBAAS Listener Details

Host: https://api.fotbo.com

Change specific LBAAS listener identified by its unique ID.

Authorizations:
apikey header authorization
query Parameters
region
string
Request Body schema: application/json
admin_state_up
required
boolean
connection_limit
required
integer
default_pool_id
required
string
description
required
string
id
required
string
name
required
string
timeout_client_data
required
integer
timeout_member_connect
required
integer
timeout_member_data
required
integer
timeout_tcp_inspect
required
integer

Responses

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "connection_limit": -1,
  • "default_pool_id": "{lbaas-pools}",
  • "description": "1111122",
  • "id": "{lbaas-listeners_id}",
  • "name": "{lbaas_name}",
  • "timeout_client_data": 50000,
  • "timeout_member_connect": 5000,
  • "timeout_member_data": 50001,
  • "timeout_tcp_inspect": 0
}

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "connection_limit": -1,
  • "created_at": "2023-11-28T09:52:26",
  • "default_pool_id": "{lbaas-pools}",
  • "description": "1111122",
  • "id": "{lbaas-listeners_id}",
  • "insert_headers": { },
  • "l7policies": [ ],
  • "name": "{lbaas_name}",
  • "operating_status": "ONLINE",
  • "protocol": "TCP",
  • "protocol_port": 11111,
  • "provisioning_status": "PENDING_UPDATE",
  • "tags": [ ],
  • "timeout_client_data": 50000,
  • "timeout_member_connect": 5000,
  • "timeout_member_data": 50001,
  • "timeout_tcp_inspect": 0,
  • "tls_ciphers": null,
  • "updated_at": "2023-11-29T14:47:38"
}

Get Load Balancer Options

Host: https://api.fotbo.com

Retrieve options for creating a new LBAAS load balancer within the Load Balancer as a Service context. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{
  • "availability_zones": [ ],
  • "certificates": [ ],
  • "flavors": [ ],
  • "listener_protocols": [
    ],
  • "monitor_http_methods": {
    },
  • "monitor_types": {
    },
  • "pool_algorithms": {
    },
  • "pool_protocols": [
    ],
  • "pool_supported_algorithms": [
    ],
  • "protocols": {
    },
  • "session_persistence_types": {
    },
  • "subnets": [
    ]
}

Get Load Balancer Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific LBAAS load balancer identified by its unique ID.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "availability_zone": null,
  • "created_at": "2023-11-28T09:52:25",
  • "description": "{description_name}",
  • "flavor_id": null,
  • "floating_ip": null,
  • "id": "{load-balancer_id}",
  • "listeners": [
    ],
  • "name": "{load-balancer_name}",
  • "operating_status": "ONLINE",
  • "pools": [
    ],
  • "project_id": "73aa943377f14b5bbef095786cd9635b",
  • "provider": "amphora",
  • "provisioning_status": "ACTIVE",
  • "tags": [ ],
  • "updated_at": "2023-11-29T14:47:42",
  • "vip_address": {
    },
  • "vip_network_id": "8e1c1d85-173c-403e-8138-1ce0457c40ec",
  • "vip_port_id": "00dcce78-6387-4028-ad35-39463ec541ab",
  • "vip_qos_policy_id": null,
  • "vip_subnet_id": "fa5956f8-8573-4dcc-8c51-ca3b91aee28c"
}

Delete Load Balancer

Host: https://api.fotbo.com

Delete a specific LBAAS load balancer identified by its unique ID.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
null

Load Balancer Permissions

Host: https://api.fotbo.com

Manage permissions related to Load Balancers.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{ }

List Load Balancer Pools

Host: https://api.fotbo.com

Retrieve a list of Load Balancer Pools associated with the user's account.

Authorizations:
apikey header authorization
query Parameters
listener_id
string
loadbalancer_id
string
region
string

Responses

Response samples

Content type
application/json
{
  • "count": 3,
  • "next": null,
  • "objects": [
    ],
  • "onePage": true,
  • "pageNo": 1,
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 3
}

Delete Load Balancer Pool

Host: https://api.fotbo.com

Delete a specific Load Balancer Pool identified by its unique ID.

Authorizations:
apikey header authorization
query Parameters
loadbalancer_id
string
region
string

Responses

Response samples

Content type
application/json
null

Change Load Balancer Pool

Host: https://api.fotbo.com

Change Load Balancer Pool. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
query Parameters
region
string
Request Body schema: application/json
admin_state_up
required
boolean
description
required
string
id
required
string
lb_algorithm
required
string
name
required
string
required
object

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "1",
  • "id": "",
  • "lb_algorithm": "SOURCE_IP_PORT",
  • "name": "{name_balanser}",
  • "session_persistence": {
    }
}

Networks (VPC)

The "Networks (VPC)" section provides detailed information on Virtual Private Cloud (VPC) functionalities. Users can create and manage networks, define subnets, and configure security settings for optimal network architecture. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Get Network VPC

Host: https://api.fotbo.com

Access information related to networks.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "objects": [
    ],
  • "totalCount": 1,
  • "pageNo": "1",
  • "permissions": {
    }
}

Create Network VPC

Host: https://api.fotbo.com

Create Network VPC. Change information about of networks.

Authorizations:
apikey header authorization
Request Body schema: application/json
admin_state_up
required
boolean
description
required
string
name
required
string
region
required
string

Responses

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "",
  • "name": "{name_vpc}",
  • "region": "{country_name}"
}

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "",
  • "dns_domain": null,
  • "id": "f11baeca-b442-45e3-a22c-e54aba25650e",
  • "mtu": null,
  • "name": "{name_vpc}",
  • "port_security_enabled": null,
  • "region": "{country_name}"
}

Get Network VPC create options

Host: https://api.fotbo.com

Retrieve options for view Network VPC. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "availability_zones": [
    ],
  • "has_hidden_regions": false,
  • "regions": [
    ],
  • "selected_region": "{country_name}"
}

Get Network Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific network in OpenStack identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "allowed_actions": [
    ],
  • "created_at": "2023-11-28T11:52:54+02:00",
  • "description": "{description_name}",
  • "dns_domain": "",
  • "extra": {
    },
  • "id": "{network_id}",
  • "is_default": false,
  • "mtu": 1450,
  • "name": "{network_name}",
  • "port_security_enabled": true,
  • "project": "73aa943377f14b5bbef095786cd9635b",
  • "region": "{country_name}",
  • "revision_number": 12,
  • "router_external": false,
  • "shared": false,
  • "status": "ACTIVE",
  • "subnets": [
    ],
  • "updated_at": "2023-11-30T13:59:06+02:00"
}

Change Network

Host: https://api.fotbo.com

Change a specific network in OpenStack identified by its unique ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
admin_state_up
required
boolean
description
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description_name}",
  • "name": "{network_name}"
}

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description_name}",
  • "dns_domain": "",
  • "mtu": 1450,
  • "name": "1111",
  • "port_security_enabled": true
}

Create Subnets

Host: https://api.fotbo.com

Retrieve a list of subnets associated with the user's account. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
cidr
required
string
enable_dhcp
required
boolean
gateway_ip
string
ip_version
required
integer
ipv6_address_mode
null or string
ipv6_ra_mode
null
name
required
string
network_address_source
required
string
network_id
required
string
network_mask
integer or string
setGatewayIp
boolean or string
object
subnetpool_id
string

Responses

Request samples

Content type
application/json
{
  • "cidr": "1.1.1.1/32",
  • "enable_dhcp": true,
  • "ip_version": 4,
  • "name": "{name_vpc}",
  • "network_address_source": "from_pool",
  • "network_id": "{network_id}",
  • "network_mask": "",
  • "subnet_pool": {
    },
  • "subnetpool_id": "a2341762-9502-41a8-b152-bceb76aa1c62"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "allocation_pools": [ ],
  • "cidr": "string",
  • "dns_nameservers": [ ],
  • "host_routes": [ ],
  • "ipv6_ra_mode": null,
  • "ipv6_address_mode": null,
  • "gateway_ip": null,
  • "name": "string",
  • "description": null,
  • "subnetpool_id": "string",
  • "ip_version": 0,
  • "enable_dhcp": true,
  • "created_at": null,
  • "updated_at": null,
  • "project": "string"
}

Change Subnet

Host: https://api.fotbo.com

Change a specific subnet associated with the user's VPS identified by ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
required
Array of objects
cidr
required
string
enable_dhcp
required
boolean
gateway_ip
required
string
ip_version
required
integer
name
required
string
network_address_source
required
string
network_id
required
string
setGatewayIp
required
boolean

Responses

Request samples

Content type
application/json
{
  • "allocation_pools": [
    ],
  • "cidr": "{cidr/24}",
  • "enable_dhcp": true,
  • "gateway_ip": "{gateway_ip}",
  • "ip_version": 4,
  • "name": "{subnets_name}",
  • "network_address_source": "manually",
  • "network_id": "6d0fe149-46e6-4d2b-89a2-82ea2e470873",
  • "setGatewayIp": true
}

Response samples

Content type
application/json
{
  • "allocation_pools": [
    ],
  • "cidr": "{cidr/24}",
  • "created_at": "2023-11-30T14:00:35+02:00",
  • "description": "",
  • "dns_nameservers": [ ],
  • "enable_dhcp": true,
  • "extra": "{'ipv6_address_mode': None, 'ipv6_ra_mode': None, 'host_routes': [], 'dns_nameservers': []}",
  • "gateway_ip": "{gateway_ip}",
  • "host_routes": [ ],
  • "id": "3e427ad1-cd77-4b4f-8cb8-b73280396b1b",
  • "ip_version": 4,
  • "name": "{subnets_name}",
  • "network": "6d0fe149-46e6-4d2b-89a2-82ea2e470873",
  • "project": "73aa943377f14b5bbef095786cd9635b",
  • "subnetpool_id": null,
  • "sync_version": 1701345636090,
  • "updated_at": "2023-11-30T14:00:35+02:00"
}

Get Subnet Creation Options

Host: https://api.fotbo.com

Retrieve options for creating a new subnet in user's account. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization
query Parameters
network_id
string

Responses

Response samples

Content type
application/json
{
  • "ipv6_modes": [
    ],
  • "pools": [
    ]
}

Routers

The "Routers" section focuses on router management, allowing users to configure and optimize routing settings for their infrastructure. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

List Routers

Host: https://api.fotbo.com

Retrieve a list of routers associated with the user's VPS.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "previous": null,
  • "objects": [ ],
  • "totalCount": 0,
  • "pageNo": "string",
  • "permissions": {
    },
  • "filter_options": {
    }
}

Create Routers

Host: https://api.fotbo.com

Retrieve a list of routers associated with the user's VPS.

Authorizations:
apikey header authorization
Request Body schema: application/json
admin_state_up
required
boolean
description
required
string
external_network_id
required
string
name
required
string
region
required
string

Responses

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description}",
  • "external_network_id": "d1117331-d769-4bb7-bebd-6e66fc91adfc",
  • "name": "{name_router}",
  • "region": "{country_name}"
}

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description}",
  • "external_network_id": "d1117331-d769-4bb7-bebd-6e66fc91adfc",
  • "id": "{router_id}",
  • "name": "{name_router}",
  • "region": "{country_name}"
}

Get Router Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific router in OpenStack identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "availability_hints": [ ],
  • "availability_zones": [
    ],
  • "description": "{description}",
  • "distributed": false,
  • "enable_snat": true,
  • "external_fixed_ips": [
    ],
  • "external_network_id": "8e1c1d85-173c-403e-8138-1ce0457c40ec",
  • "ha": true,
  • "id": "{router_id}",
  • "interfaces": [
    ],
  • "name": "{interfaces_name}",
  • "network_name": "nl-public-v4-1",
  • "project": "73aa943377f14b5bbef095786cd9635b",
  • "region": "{country_name}",
  • "routes": [ ],
  • "status": "ACTIVE"
}

Get Router Details

Host: https://api.fotbo.com

Changing the specific router associated with the VPS, identified by its unique ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
admin_state_up
required
boolean
description
required
string
id
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description}",
  • "id": "{router_id}",
  • "name": "{interfaces_name}"
}

Response samples

Content type
application/json
{
  • "admin_state_up": true,
  • "description": "{description}",
  • "external_network_id": "8e1c1d85-173c-403e-8138-1ce0457c40ec",
  • "name": "{interfaces_name}"
}

Delete Router

Host: https://api.fotbo.com

Delete a specific Router identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
null

Add Interface to Router

Host: https://api.fotbo.com

Add an interface to the specified router associated with the user's VPS. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
ip
required
string
subnet
required
string

Responses

Request samples

Content type
application/json
{
  • "ip": "{ip_instance}",
  • "subnet": "7659285a-30cd-421b-a19a-9d7e5051e484"
}

Response samples

Content type
application/json
{
  • "detail": "Unable to add interface, please contact support."
}

Get Add Interface Options to Router

Host: https://api.fotbo.com

Retrieve options for adding an interface to the specified router associated with the VPS, identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

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

Get Router Creation Options

Host: https://api.fotbo.com

Retrieve options for creating a new router associated with the VPS, identified by its unique ID. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "availability_zones": [
    ],
  • "external_networks": [
    ],
  • "has_hidden_regions": false,
  • "regions": [
    ],
  • "selected_region": "{country_name}"
}

Router Permissions

Host: https://api.fotbo.com

Manage permissions related to routers associated with the VPS.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "routers.add_interface": true,
  • "routers.create": true,
  • "routers.destroy": true,
  • "routers.list": true,
  • "routers.remove_interface": true,
  • "routers.retrieve": true,
  • "routers.update": true
}

Zones (DNS)

The "Zones (DNS)" section covers Domain Name System (DNS) functionalities. Users can manage DNS zones, configure domain settings, and ensure seamless domain resolution for their services. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

List Zones DNS

Host: https://api.fotbo.com

Access DNS-related information within the services context.

Authorizations:
apikey header authorization
query Parameters
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ],
  • "permissions": {
    },
  • "hasMore": true
}

Create Zones DNS

Host: https://api.fotbo.com

Change Zones DNS

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
email
required
string
ip_address
required
string
name
required
string
ttl
required
integer

Responses

Request samples

Content type
application/json
{
  • "description": "{description}",
  • "email": "mail@{sub.domain.name}",
  • "ip_address": "",
  • "name": "{sub.domain.name}",
  • "ttl": 1800
}

Response samples

Content type
application/json
{
  • "action": "CREATE",
  • "attributes": { },
  • "created_at": "2023-11-29T15:26:05.000000",
  • "description": "{description}",
  • "email": "mail@{sub.domain.name}",
  • "id": "{zone_dns_id}",
  • "masters": [ ],
  • "name": "{sub.domain.name}.",
  • "pool_id": "84c00fa0-33fc-4c39-8b3a-30b3e7d97da9",
  • "project_id": "73aa943377f14b5bbef095786cd9635b",
  • "serial": 1701271565,
  • "shared": false,
  • "status": "PENDING",
  • "transferred_at": null,
  • "ttl": 1800,
  • "type": "PRIMARY",
  • "updated_at": null,
  • "version": 1
}

Delete DNS Zone record

Host: https://api.fotbo.com

Delete a specific DNS zone identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
null

Get DNS Zone Details

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-11-29T15:15:27.000000",
  • "description": "{sub.domain.name}",
  • "email": "mail@{sub.domain.name}",
  • "id": "{zone_dns_id}",
  • "name": "{sub.domain.name}",
  • "project_id": "73aa943377f14b5bbef095786cd9635b",
  • "status": "PENDING",
  • "ttl": 3600,
  • "type": "PRIMARY",
  • "updated_at": "2023-11-29T15:18:27.000000"
}

Change DNS Zone Details

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
email
required
string
id
required
string
ip_address
required
string
ttl
required
integer

Responses

Request samples

Content type
application/json
{
  • "description": "{sub.domain.name}",
  • "email": "mail@{sub.domain.name}",
  • "id": "{zone_dns_id}",
  • "ip_address": "",
  • "ttl": 3601
}

Response samples

Content type
application/json
{
  • "action": "UPDATE",
  • "attributes": { },
  • "created_at": "2023-11-29T15:15:27.000000",
  • "description": "{sub.domain.name}",
  • "email": "mail@{sub.domain.name}",
  • "id": "{zone_dns_id}",
  • "masters": [ ],
  • "name": "{sub.domain.name}.",
  • "pool_id": "84c00fa0-33fc-4c39-8b3a-30b3e7d97da9",
  • "project_id": "73aa943377f14b5bbef095786cd9635b",
  • "serial": 1701271043,
  • "shared": false,
  • "status": "PENDING",
  • "transferred_at": null,
  • "ttl": 3600,
  • "type": "PRIMARY",
  • "updated_at": "2023-11-29T15:17:23.000000",
  • "version": 13
}

List DNS Records

Host: https://api.fotbo.com

Retrieve a list of DNS records associated with the specified DNS zone.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "min_ttl": 300,
  • "read_only_recordsets": [
    ],
  • "record_types": [
    ],
  • "recordsets": [
    ]
}

Synchronize DNS Records

Host: https://api.fotbo.com

Synchronize DNS records for the specified DNS zone.

Authorizations:
apikey header authorization
Request Body schema: application/json
Array
action
string
changed
boolean
created
boolean
deleted
boolean
id
string
name
required
string
records
required
Array of strings
ttl
required
integer
type
required
string
zone_id
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "created_recordsets": [ ],
  • "detail": "Recordsets update scheduled",
  • "read_only_recordsets": [
    ],
  • "record_types": [
    ],
  • "recordsets": [
    ]
}

Create or update PTR

Host: https://api.fotbo.com

Create or update a PTR (pointer) record for the specified service within the DNS context.

Authorizations:
apikey header authorization
Request Body schema: application/json
ip
required
string
record
required
string
region_name
required
string
zone_id
string

Responses

Request samples

Content type
application/json
{
  • "ip": "{fixed_ip}",
  • "record": "{you.domain.com}",
  • "region_name": "{country_name}",
  • "zone_id": "a60a0e56-85b7-43ab-84ab-41903b3e8542"
}

Response samples

Content type
application/json
{}

Get Floating IP PTR

Host: https://api.fotbo.com

Retrieve PTR records associated with a floating IP within the DNS context.

Authorizations:
apikey header authorization
query Parameters
floating_ip_id
string

Responses

Response samples

Content type
application/json
{}

Get DNS Price

Host: https://api.fotbo.com

Retrieve pricing information related to DNS services within the services context.

Authorizations:
apikey header authorization
query Parameters
email
string
ttl
string

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.00 / hour<br>\nor €0.00 / month"
}

Get PTR Record from IP

Host: https://api.fotbo.com

Retrieve PTR records associated with a specified IP address within the DNS context.

Authorizations:
apikey header authorization
query Parameters
ip
string
region_name
string

Responses

Response samples

Content type
application/json
{
  • "record": "{you.domain.com}",
  • "zone_id": "a60a0e56-85b7-43ab-84ab-41903b3e8542"
}

DNS Permissions

Host: https://api.fotbo.com

Retrieve permissions related to DNS services within the DNS context.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "dns.create": true,
  • "dns.create_or_update_ptr": true,
  • "dns.destroy": true,
  • "dns.list": true,
  • "dns.retrieve": true,
  • "dns.synchronize_records": true,
  • "dns.update": true
}

Set Floating IP PTR

Host: https://api.fotbo.com

Set PTR records for a floating IP within the DNS context.

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
floating_ip_id
required
string
ptrdname
required
string
ttl
required
integer

Responses

Request samples

Content type
application/json
{
  • "description": "{description}",
  • "floating_ip_id": "{floating_ip_id}",
  • "ptrdname": "{ptrd_name}",
  • "ttl": 1800
}

Response samples

Content type
application/json
{}

Security groups

The "Security groups" section provides tools for managing security policies. Users can define and apply security group rules to control inbound and outbound traffic, enhancing the overall security posture.

List Security Groups

Host: https://api.fotbo.com

Retrieve a list of security groups associated with the user's account. You may not have services or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

Get Security Group Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific security group identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "associated_instances": [ ],
  • "created_at": "2023-11-29T17:32:55+02:00",
  • "description": "3",
  • "id": "{securitygroup_id}",
  • "name": "31",
  • "project": "73aa943377f14b5bbef095786cd9635b",
  • "region": "{country_name}",
  • "security_group_rules": [
    ],
  • "updated_at": "2023-11-29T17:33:16+02:00"
}

Change Security Group

Host: https://api.fotbo.com

Change settings a specific security group identified by ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "3",
  • "name": "31"
}

Response samples

Content type
application/json
{
  • "description": "3",
  • "id": "{securitygroup_id}",
  • "name": "3"
}

Add Rule to Security Group

Host: https://api.fotbo.com

Add a rule to the settings in specified security group identified by ID in user's account.

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
direction
required
string
protocol
required
string
remote_ip_prefix
required
string
security_group_id
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "",
  • "direction": "ingress",
  • "protocol": "UDP",
  • "remote_ip_prefix": "0.0.0.0/0",
  • "security_group_id": "{securitygroup_id}"
}

Response samples

Content type
application/json
{
  • "detail": "Rule create scheduled"
}

Delete Rule from Security Group

Host: https://api.fotbo.com

Delete a rule from the specified security group in user's account.

Authorizations:
apikey header authorization
Request Body schema: application/json
rule_id
required
string

Responses

Request samples

Content type
application/json
{
  • "rule_id": "9d531d50-3e18-4955-a10f-f4e5a3c0cf5c"
}

Response samples

Content type
application/json
null

Security Group Permissions

Host: https://api.fotbo.com

Manage permissions related to security groups in user's account.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "securitygroups.add_rule": true,
  • "securitygroups.create": true,
  • "securitygroups.delete_rule": true,
  • "securitygroups.destroy": true,
  • "securitygroups.list": true,
  • "securitygroups.retrieve": true,
  • "securitygroups.update": true
}

Floating IPs

The "Floating IPs" section explores functionalities related to floating IP addresses. Users can allocate, associate, and manage floating IPs to achieve flexible and scalable network configurations. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Floating IPs

Host: https://api.fotbo.com

Access information related to floating IPs within the OpenStack context.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "previous": null,
  • "objects": [ ],
  • "totalCount": 0,
  • "pageNo": 0,
  • "permissions": {
    },
  • "filter_options": {
    }
}

Create Floating IPs

Authorizations:
apikey header authorization
Request Body schema: application/json
description
required
string
floating_network
required
string
region
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "111",
  • "floating_network": "8e1c1d85-173c-403e-8138-1ce0457c40ec",
  • "region": "{country_name}"
}

Response samples

Content type
application/json
{
  • "description": "111",
  • "floating_network": "8e1c1d85-173c-403e-8138-1ce0457c40ec",
  • "id": "c5874698-2fb8-4c7c-b85f-d9bc979da12b"
}

Get Floating IP Options

Host: https://api.fotbo.com

Retrieve options for creating a new floating IP. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "default_region": "{country_name}",
  • "networks": [
    ],
  • "regions": [
    ]
}

Get Floating IP Price

Host: https://api.fotbo.com

Retrieve the price for creating a new floating IP.

Authorizations:
apikey header authorization
query Parameters
region
string

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.0042 / hour<br>\nor €3.00 / month"
}

SSH Keys

The "SSH Keys" section focuses on Secure Shell (SSH) key management. Users can add, remove, and manage SSH keys for secure access to instances and services. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

List PKM Items

Host: https://api.fotbo.com

Retrieve a list of PKM (Public Key Management) items associated with the user's account.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 3,
  • "next": null,
  • "objects": [
    ],
  • "pageNo": "1",
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 3
}

Add PKM Items

Host: https://api.fotbo.com

Add PKM (Public Key Management) items associated with the user's account.

Authorizations:
apikey header authorization
Request Body schema: application/json
name
required
string
private_key
required
string
public_key
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "{ssh_key_name}",
  • "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwWBbjzibb7jBc7vEK+v+JbRE/OqDO9BXm/1FdO9lpzINMMUc\ngk9syBDgnel4wNW+1iB+ZlHJg2H8IV5+KW2URUv4gPxvdKcl5ab4eWRxEeQBbmAl\n7N/MmKOIOw1+kSb8qFWvp2EqAiGVyuJRFTtQLMUwZ+EK93De2nL9AZCtPAPte8XY\nRKAQOe8Q3EOSEDrVLA17q6R1mIsqieV8hs5ma1fU34hS5RysoJMOtosIdVEy1RsM\nsxxTevRl/cuXZ3pcKIKH9RrsvYfNOF2rcbu+4Hjjc157FWdstp7ctbrwSfl1EViX\ncidnT6nsWZlJMMV9OkgU3eV4zCZUz9pJW/AyRwIDAQABAoIBACSVxVzIWef+LWNm\n/8tLf67Ed1TeTWvQk/KoLS7dZ/8E4if68tTYj/0d7FET7cuV5OAAD8nt6VEZBamO\nhhHycF3X7LECkVehk/Lp7xKQZS/8UiT+vc4d3Uh3j/uUJwDxPlXeuDfTky4KCpvy\ny2JX8Wg2+lx84CVGTnNH1AQqyguTYnaE2TvRKPBM4MeGsE0yVcIIOjKVCwRP/gf2\np5tKa3hMLSUZMDZovYs1/SRHLtERhoZHdSUWBjtUEdVXouIGhcsQ/388SRCyxntm\nVHOy5Q7knS/jxFDZtrFtODNEB9wkr9qeT3Uvm7nsOxGd7VPCv3fisgQojE0UWXTW\nUDz/SOECgYEA4FgzOokXwnMhdydD2V2XZEi1ChjixkTUd2OCxcN29tAT65UkD2sl\nv4FQetkJibP4k9fR0zUTQTwvyVcm9kxS3RtAZ7EwjhuGWe4hF9FvtxHM4O9TJbN2\nCmFrRCORDSPCRuCBTK/eYVwU15NxrFLhOhBufXsgvgAY7bjOiIuNFncCgYEA3KmF\n3IwOqGLQd/t/h2VC+tz8j36UZN4BhE2e/apWcynhVY6PgyOO/bkhPxAv5ZzQm7Cf\n7rgMrYsX1f/T4qAciVzwT8oajZrNn4MKONyz072KtHCTRJrIc2ztMrCCevDveVwN\nKHRNAoinQCKxo1ClKTKErEiOViF/AtiINe/iJrECgYBZTAIoHIVuirEZYnGpRY2L\nBz24ZStuy9reIqfc2+6wUyZ6sQSHdpix32EPZPBc9VvOTSthrFCbuL80nxING1go\nVj6Oh4LSLbaOeTCG8IBNGDK6ncg0y3gCrcAqgRWtazxbReVxhtc3XZWWMUQf2WV4\n3S19mNLxjcxeYx8iTpm8BQKBgG5QBU6jafR+Kc/BmBic4+Y7sbsewZrHbaSxlUkk\n7cD27+JwuYgKr8Jh2aAIPJmiUptyqhGSSyw6+/iMw2VpO7rkDnMlCy89c4xJ20Nf\n+jphaEUaflTuuEUT8GTF3wUNC/r0rNNLiPA6Vrp2Xa3SdC7rRW5He3jNmAxZKYcl\nXD6RAoGBAJdPyuuQ2jbRSRfop1y/eHpjAx5tn9jcMiYab/ZCClGhLsS+XciDVqWX\n/hOFyVORQBLzFNMdwP3xpaWbtQt6xlb7Nb/C0SML6NVY+vp3vHeDav2EfkpSrFId\neP1OAarGHAN/CwqXCO98ehsQf1V0VdvU9IUkKCSY7e5u3QVT+hMy\n-----END RSA PRIVATE KEY-----\n",
  • "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDBYFuPOJtvuMFzu8Qr6/4ltET86oM70Feb/UV072WnMg0wxRyCT2zIEOCd6XjA1b7WIH5mUcmDYfwhXn4pbZRFS/iA/G90pyXlpvh5ZHER5AFuYCXs38yYo4g7DX6RJvyoVa+nYSoCIZXK4lEVO1AsxTBn4Qr3cN7acv0BkK08A+17xdhEoBA57xDcQ5IQOtUsDXurpHWYiyqJ5XyGzmZrV9TfiFLlHKygkw62iwh1UTLVGwyzHFN69GX9y5dnelwogof1Guy9h804Xatxu77geONzXnsVZ2y2nty1uvBJ+XURWJdyJ2dPqexZmUkwxX06SBTd5XjMJlTP2klb8DJH"
}

Response samples

Content type
application/json
{
  • "created_at": "2023-11-30T10:58:57.026303+02:00",
  • "fingerprint": "bb:46:b8:5c:8f:2c:d4:a8:d0:71:c1:e1:88:a4:94:4d",
  • "id": 61,
  • "name": "{ssh_key_name}",
  • "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDBYFuPOJtvuMFzu8Qr6/4ltET86oM70Feb/UV072WnMg0wxRyCT2zIEOCd6XjA1b7WIH5mUcmDYfwhXn4pbZRFS/iA/G90pyXlpvh5ZHER5AFuYCXs38yYo4g7DX6RJvyoVa+nYSoCIZXK4lEVO1AsxTBn4Qr3cN7acv0BkK08A+17xdhEoBA57xDcQ5IQOtUsDXurpHWYiyqJ5XyGzmZrV9TfiFLlHKygkw62iwh1UTLVGwyzHFN69GX9y5dnelwogof1Guy9h804Xatxu77geONzXnsVZ2y2nty1uvBJ+XURWJdyJ2dPqexZmUkwxX06SBTd5XjMJlTP2klb8DJH",
  • "user": {
    }
}

Change PKM Item Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific PKM item identified by ID. You may have entered the wrong ssh-key.

Authorizations:
apikey header authorization
Request Body schema: application/json
name
required
string
private_key
required
string
public_key
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "{ssh_key_name}",
  • "private_key": "",
  • "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCmuSAq7+wsp0ViSNWbCZYj3UAVuObKHrSDNR+pZM06UU21JDLmVqPH9IhDthWFqpl/68d6Sd2zfWVQCZiuhAobuhpwJNGecOx2tWNQZmiT6SN2AxHUeyaG3yuQ/nGmvJB+yL0ZV9OmFz9THHqgFSH205y0/GmUciD0R4TrADYtn80vb9wC0Xhnsm4t7T/rgSKyYhpNPSv1TZzD7yIKmVi+mLc1XLeGiegGODSqn5kdor9QMiO/KVhth6Ui7zaazdmuC9HCtpgGaDFAteiHhOUvdIWPvLLi2CMSr2c2j+roUUDxtq4quMIbR4/5CM6gQ8CWD2r3tK1BsYFtkl6opTW111/"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "public_key": "string",
  • "created_at": "string",
  • "fingerprint": "string",
  • "user": {
    }
}

Delete SSH Keys

Host: https://api.fotbo.com

Delete a specific SSH Key identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
null

Get Generated Key Pair

Host: https://api.fotbo.com

Retrieve information about the generated key pair in the PKM context.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwWBbJzibb7jBc7vEK+v+JbRE/OqDO9BXm/1FdO9lpzINMMUc\ngk9syBDgnel4wNW+1iB+ZlHJg2H8IV5+KW2URUv4gPxvdKcl5ab4eWRxEeQBbmAl\n7N/MmKOIOw1+kSb8qFWvp2EqAiGVyuJRFTtQLMUwZ+EK93De2nL9AZCtPAPte8XY\nRKAQOe8Q3EOSEDrVLA17q6R1mIsqieV8hs5ma1fU34hS5RysoJMOtosIdVEy1RsM\nsxxTevRl/cuXZ3pcKIKH9RrsvYfNOF2rcbu+4Hjjc157FWdstp7ctbrwSfl1EViX\ncidnT6nsWZlJMMV9OkgU3eV4zCZUz9pJW/AyRwIDAQABAoIBACSVxVzIWef+LWNm\n/8tLf67Ed1TeTWvQk/KoLS7dZ/8E4if68tTYj/0d7FET7cuV5OAAD8nt6VEZBamO\nhhHycF3X7LECkVehk/Lp7xKQZS/8UiT+vc4d3Uh3j/uUJwDxPlXeuDfTky4KCpvy\ny2JX8Wg2+lx84CVGTnNH1AQqyguTYnaE2TvRKPBM4MeGsE0yVcIIOjKVCwRP/gf2\np5tKa3hMLSUZMDZovYs1/SRHLtERhoZHdSUWBjtUEdVXouIGhcsQ/388SRCyxntm\nVHOy5Q7knS/jxFDZtrFtODNEB9wkr9qeT3Uvm7nsOxGd7VPCv3fisgQojE0UWXTW\nUDz/SOECgYEA4FgzOokXwnMhdydD2V2XZEi1ChjixkTUd2OCxcN29tAT65UkD2sl\nv4FQetkJibP4k9fR0zUTQTwvyVcm9kxS3RtAZ7EwjhuGWe4hF9FvtxHM4O9TJbN2\nCmFrRCORDSPCRuCBTK/eYVwU15NxrFLhOhBufXsgvgAY7bjOiIuNFncCgYEA3KmF\n3IwOqGLQd/t/h2VC+tz8j36UZN4BhE2e/apWcynhVY6PgyOO/bkhPxAv5ZzQm7Cf\n7rgMrYsX1f/T4qAciVzwT8oajZrNn4MKONyz072KtHCTRJrIc2ztMrCCevDveVwN\nKHRNAoinQCKxo1ClKTKErEiOViF/AtiINe/iJrECgYBZTAIoHIVuirEZYnGpRY2L\nBz24ZStuy9reIqfc2+6wUyZ6sQSHdpix32EPZPBc9VvOTSthrFCbuL80nxING1go\nVj6Oh4LSLbaOeTCG8IBNGDK6ncg0y3gCrcAqgRWtazxbReVxhtc3XZWWMUQf2WV4\n3S19mNLxjcxeYx8iTpm8BQKBgG5QBU6jafR+Kc/BmBic4+Y7sbsewZrHbaSxlUkk\n7cD27+JwuYgKr8Jh2aAIPJmiUptyqhGSSyw6+/iMw2VpO7rkDnMlCy89c4xJ20Nf\n+jphaEUaflTuuEUT8GTF3wUNC/r0rNNLiPA6Vrp2Xa3SdC7rRW5He3jNmAxZKYcl\nXD6RAoGBAJdPyuuQ2jbRSRfop1y/eHpjAx5tn9jcMiYab/ZCClGhLsS+XciDVqWX\n/hOFyVORQBLzFNMdwP3xpaWbtQt6xlb7Nb/C0SML6NVY+vp3vHeDav2EfkpSrFId\neP1OAarGHAN/CwqXCO98ehsQf1V0VdvU9IUkKCSY7e5u3QVT+hMy\n-----END RSA PRIVATE KEY-----\n",
  • "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDBYFuPOJtvuMFzu0Qr6/4ltET86oM70Feb/UV072WnMg0wxRyCT2zIEOCd6XjA1b7WIH5mUcmDYfwhXn4pbZRFS/iA/G90pyXlpvh5ZHER5AFuYCXs38yYo4g7DX6RJvyoVa+nYSoCIZXK4lEVO1AsxTBn4Qr3cN7acv0BkK08A+17xdhEoBA57xDcQ5IQOtUsDXurpHWYiyqJ5XyGzmZrV9TfiFLlHKygkw62iwh1UTLVGwyzHFN69GX9y5dnelwogof1Guy9h804Xatxu77geONzXnsVZ2y2nty1uvBJ+XURWJdyJ2dPqexZmUkwxX06SBTd5XjMJlTP2klb8DJH"
}

My Images

Get Images

Host: https://api.fotbo.com

Access information related to images within the OpenStack context.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "filter_options": {
    },
  • "next": null,
  • "objects": [ ],
  • "pageNo": "1",
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 0
}

Create Images

Authorizations:
apikey header authorization
Request Body schema: multipart/form-data; boundary=----WebKitFormBoundary0Ft0CQRQCgYLsd5B
Schema not provided

Responses

Request samples

Content type
multipart/form-data; boundary=----WebKitFormBoundary0Ft0CQRQCgYLsd5B
null

Response samples

Content type
application/json
{
  • "architecture": "",
  • "container_format": "bare",
  • "disk_format": "iso",
  • "hypervisor_type": "",
  • "id": "{image_id}",
  • "min_disk": 0,
  • "min_ram": 0,
  • "name": "{name_image}",
  • "os_distro": "",
  • "os_version": "{os_version}",
  • "protected": false,
  • "region": "{country_name}",
  • "source": "url",
  • "tags": [ ],
  • "visibility": "private"
}

Get Image-ISO Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific Images or ISO identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "architecture": null,
  • "assigned_to_flavor": true,
  • "cleanup_date": null,
  • "client": {
    },
  • "container_format": "bare",
  • "created_at": "2023-11-30T16:05:15+02:00",
  • "deleted_at": null,
  • "disk_format": "iso",
  • "display_name": "{iso_image_name}",
  • "hw_qemu_guest_agent": false,
  • "hypervisor_type": null,
  • "id": "{image_id}",
  • "instance_uuid": null,
  • "is_iso": true,
  • "min_disk": 0,
  • "min_ram": 0,
  • "name": "{iso_image}",
  • "os_distro": null,
  • "os_version": null,
  • "properties": { },
  • "protected": false,
  • "region": "{country_name}",
  • "related_instance": null,
  • "reseller_resources": null,
  • "size": 260046848,
  • "status": "active",
  • "tags": [ ],
  • "type": "template",
  • "updated_at": "2023-11-30T16:06:28+02:00",
  • "used_by_resellers": [ ],
  • "visibility": "private",
  • "volume_snapshot_uuid": null
}

Change Image-ISO Details

Host: https://api.fotbo.com

Images, ISO

Authorizations:
apikey header authorization
Request Body schema: application/json
architecture
required
string
disk_format
required
string
hypervisor_type
required
null
id
required
string
min_disk
required
integer
min_ram
required
integer
name
required
string
os_distro
required
string
os_version
required
string
properties
required
object
protected
required
boolean
visibility
required
string

Responses

Request samples

Content type
application/json
{
  • "architecture": "i686",
  • "disk_format": "ami",
  • "hypervisor_type": null,
  • "id": "fba0b9b1-608b-49d4-bcdd-b09466679433",
  • "min_disk": 1,
  • "min_ram": 2,
  • "name": "{name_distr_OS}",
  • "os_distro": "{distr_OS}",
  • "os_version": "{os_version}",
  • "properties": { },
  • "protected": false,
  • "visibility": "private"
}

Response samples

Content type
application/json
{
  • "architecture": "i686",
  • "hypervisor_type": null,
  • "min_disk": 1,
  • "min_ram": 2,
  • "name": "{name_distr_OS}",
  • "os_distro": "{distr_OS}",
  • "os_version": "{os_version}",
  • "properties": { },
  • "protected": false,
  • "tags": [ ],
  • "visibility": "private"
}

Delete Images-ISO

Host: https://api.fotbo.com

Delete a specific Images or ISO identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
null

Copy Image

Host: https://api.fotbo.com

Copy the specified image.

Authorizations:
apikey header authorization
Request Body schema: application/json
delete_source_image
required
boolean
destination_name
required
string
destination_region_id
required
string

Responses

Request samples

Content type
application/json
{
  • "delete_source_image": false,
  • "destination_name": "{name_image}",
  • "destination_region_id": "{country_name}"
}

Response samples

Content type
application/json
{
  • "detail": "Image {name_image} copy scheduled"
}

Get Snapshots for Instance

Host: https://api.fotbo.com

Retrieve snapshots associated with a specific instance.

Authorizations:
apikey header authorization
query Parameters
instance_uuid
string

Responses

Response samples

Content type
application/json
{
  • "objects": [
    ],
  • "volume_snapshots_count": 0
}

Image Permissions

Host: https://api.fotbo.com

Retrieve permissions related to images within the OpenStack context.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "images.create": true,
  • "images.deactivate": true,
  • "images.destroy": true,
  • "images.download": true,
  • "images.list": true,
  • "images.reactivate": true,
  • "images.retrieve": true,
  • "images.update": true
}

Get Image Price

Host: https://api.fotbo.com

Retrieve the price for creating a new image within the OpenStack context.

Authorizations:
apikey header authorization
query Parameters
disk_format
string
region
string
size
string
visibility
string

Responses

Response samples

Content type
application/json
{
  • "estimated_cost_display": "ESTIMATED COST<br>\n€0.00 / hour<br>\nor €0.01 / month"
}

Billing

The "Billing" section provides comprehensive information on billing-related functionalities. Users can explore features such as viewing and managing invoices, setting up payment methods, and accessing billing history for transparent financial transactions. Provides comprehensive details about managing and interacting with invoices for our hosting services. Here, users can access and handle various aspects of their billing history, ensuring transparency and control over financial transactions. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Get Auto-Invoicing Settings

Host: https://api.fotbo.com

List auto-invoicing settings for the user's account.

Authorizations:
apikey header authorization
query Parameters
client_id
string

Responses

Response samples

Content type
application/json
{
  • "auto_invoicing_settings": {
    }
}

Create Auto-Invoicing Settings

Host: https://api.fotbo.com

Access and manage auto-invoicing settings for the user's account.

Authorizations:
apikey header authorization
query Parameters
active_client
string
Request Body schema: application/json
auto_invoicing_amount
required
null or integer
auto_invoicing_type
required
string
enable_auto_invoicing
required
boolean

Responses

Request samples

Content type
application/json
{
  • "auto_invoicing_amount": null,
  • "auto_invoicing_type": "string",
  • "enable_auto_invoicing": true
}

Response samples

Content type
application/json
{
  • "auto_invoicing_amount": null,
  • "auto_invoicing_type": "string",
  • "enable_auto_invoicing": true
}

Get Configured Recurring Payment Options

Host: https://api.fotbo.com

Retrieve configured options for recurring payments associated with billing gateways.

Authorizations:
apikey header authorization

Responses

Response samples

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

List Invoices

Host: https://api.fotbo.com

Retrieve a list of invoices associated with the user's account, providing an overview of billing history.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "filter_options": {
    },
  • "next": null,
  • "objects": [
    ],
  • "pageNo": "1",
  • "permissions": {
    },
  • "previous": null,
  • "totalCount": 1,
  • "unpaid_invoice_id": "{invoices_id}",
  • "unpaid_invoices": 1
}

About invoice

Host: https://api.fotbo.com

Retrieve detailed information about a specific invoice identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "address1": "Adress line 1",
  • "balance": "12.30",
  • "city": "City",
  • "client": {
    },
  • "company": "",
  • "country": "PL",
  • "currency": "EUR",
  • "customer_details": "John Last\nAdress line 1\nCity, {country_name}\n{+id_phone_number}",
  • "detailed_invoice": true,
  • "display_number": "{invoices_id}",
  • "due_date": "2023-11-16T10:53:40.760503+02:00",
  • "email": "",
  • "fax": null,
  • "first_name": "John",
  • "fiscal_date": null,
  • "fiscal_due_date": null,
  • "fleio_info": "Company name: {Company_name}\nCompany type: LLC\nRegistration number: 40103450338\nVAT number: LV40103450338\nLegal address: Ernesta Birznieka-Upisa street 18, Riga, Latvia\nPost code: LV-1050",
  • "id": "{invoices_id}",
  • "is_fiscal": false,
  • "is_upgrade_invoice": false,
  • "issue_date": "2023-11-16T10:53:40.760490+02:00",
  • "items": [
    ],
  • "journal": [ ],
  • "last_name": "Last",
  • "name": "Proforma {invoices_id}",
  • "number": null,
  • "payment_options": {
    },
  • "phone": "{+id_phone_number}",
  • "state": "-",
  • "status": "unpaid",
  • "subtotal": "10.00",
  • "taxes": [
    ],
  • "total": "12.30",
  • "vat_id": "",
  • "zip_code": "00000"
}

Add Credit Invoice

Host: https://api.fotbo.com

Creating and add a credit invoice

Authorizations:
apikey header authorization
Request Body schema: application/json
credit
required
integer

Responses

Request samples

Content type
application/json
{
  • "credit": 11
}

Response samples

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

Billing Summary

Host: https://api.fotbo.com

Access a summary of billing information, providing an overview of the user's financial status.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "billing_currency": "EUR",
  • "credits": [ ],
  • "invoices_details": {
    },
  • "latest_data_from": "2023-12-01T13:30:01.091204Z",
  • "services_count": 0,
  • "uptodate_credit": -0.54,
  • "validate_credit_card": false
}

Get External URL

Host: https://api.fotbo.com

Retrieve the external URL for billing purposes.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "external_billing_url": ""
}

Billing

Host: https://api.fotbo.com

Access OpenStack-specific billing information.

Authorizations:
apikey header authorization
query Parameters
page_size
string

Responses

Response samples

Content type
application/json
{
  • "available_services": [
    ],
  • "count": 1,
  • "credit_and_invoicing_info": {
    },
  • "estimated_cycle_cost": {
    },
  • "latest_data_from": "2023-12-01T13:30:01.091204Z",
  • "next": null,
  • "objects": [
    ],
  • "pageNo": 1,
  • "previous": null,
  • "totalCount": 1
}

Credit and Invoicing Information

Host: https://api.fotbo.com

Retrieve credit and invoicing information within billing context.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "has_billing_agreement": false,
  • "reached_credit_limit": true,
  • "remaining_days": 0,
  • "remaining_hours": 0
}

Clients

The "Clients" section covers client-related functionalities. Users can manage client information, access usage statistics, and ensure a seamless client experience. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Generate token

Host: https://api.fotbo.com

Generate a One-Time Password (OTP) token for authentication purposes.

Authorizations:
apikey header authorization
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "token": "19c016cb11f03fec2904baeb80cb12aee779a76"
}

Confirm email

Host: https://api.fotbo.com

Confirm the user's email address.

Authorizations:
apikey header authorization
Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "6ge-ff65f824992c4fcfec777d5ef8cab620"
}

Response samples

Content type
application/json
{
  • "detail": "Email successfully confirmed"
}

Get Current User

Host: https://api.fotbo.com

Retrieve information about the currently authenticated user.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "cart_items": 0,
  • "edition": "full",
  • "features": {
    },
  • "formatting": {
    },
  • "has_panel_notifications": false,
  • "impersonated": false,
  • "is_development": false,
  • "is_white_label": false,
  • "notifications": 1,
  • "requires_email_verification": false,
  • "total_notifications": 1,
  • "user": {
    },
  • "uuid": "2f2163a7278923142e2e88a280e011bb935f5a4fc4af2e11b3627cadad3c73a9",
  • "version": {
    }
}

Get Dynamic UI App Menu

Host: https://api.fotbo.com

Retrieve the dynamic application menu for the user interface.

Authorizations:
apikey header authorization

Responses

Response samples

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

Get External URL

Host: https://api.fotbo.com

Retrieve the external URL for billing purposes.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "external_billing_url": ""
}

List Clients

Host: https://api.fotbo.com

Retrieve a list of clients associated with the user's account.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "objects": [
    ],
  • "pageNo": "1",
  • "previous": null,
  • "totalCount": 1
}

Create Clients

Host: https://api.fotbo.com

You may not have access or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
address1
required
string
address2
required
string
city
required
string
company
required
string
country
required
string
custom_fields
required
Array of arrays
first_name
required
string
last_name
required
string
phone
required
string
state
required
string
vat_id
required
string
zip_code
required
string

Responses

Request samples

Content type
application/json
{
  • "address1": "Address line 1",
  • "address2": "",
  • "city": "City",
  • "company": "Fotbo",
  • "country": "AF",
  • "custom_fields": [ ],
  • "first_name": "Member",
  • "last_name": "Last",
  • "phone": "+03712345678",
  • "state": "State",
  • "vat_id": "Fotbo",
  • "zip_code": "12345"
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "company": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "country": "string",
  • "state": "string",
  • "zip_code": "string",
  • "phone": "string",
  • "fax": null,
  • "vat_id": "string",
  • "custom_fields": [ ],
  • "id": 0
}

Get Client Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific client identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "address1": "Address line 1",
  • "address2": "",
  • "city": "City",
  • "company": "Fotbo",
  • "country": "AF",
  • "country_name": "Afghanistan",
  • "credits": [
    ],
  • "currency": "EUR",
  • "custom_fields": [ ],
  • "date_created": "2023-11-28T16:14:36.422845+02:00",
  • "fax": null,
  • "first_name": "Member",
  • "has_openstack_services": true,
  • "id": "{client_id}",
  • "last_name": "Last",
  • "long_name": "Fotbo (Member Last)",
  • "name": "Member Last",
  • "phone": "+93712345678",
  • "roles": [
    ],
  • "state": "State",
  • "status": "active",
  • "users": [
    ],
  • "vat_id": "FOTBO",
  • "zip_code": "12345"
}

Change Client

Host: https://api.fotbo.com

Change a specific client identified by ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
address1
required
string
address2
required
string
city
required
string
company
required
string
country
required
string
custom_fields
required
Array of arrays
first_name
required
string
last_name
required
string
phone
required
string
state
required
string
vat_id
required
string
zip_code
required
string

Responses

Request samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "company": "string",
  • "country": "string",
  • "custom_fields": [ ],
  • "first_name": "string",
  • "last_name": "string",
  • "phone": "string",
  • "state": "string",
  • "vat_id": "string",
  • "zip_code": "string"
}

Response samples

Content type
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "company": "string",
  • "country": "string",
  • "country_name": "string",
  • "custom_fields": [ ],
  • "fax": null,
  • "first_name": "string",
  • "id": 0,
  • "last_name": "string",
  • "phone": "string",
  • "state": "string",
  • "vat_id": "string",
  • "zip_code": "string"
}

Dissociate User from Client

Host: https://api.fotbo.com

Dissociate a user from the specified client. Delete invite.

Authorizations:
apikey header authorization
Request Body schema: application/json
id
required
string
relation_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": "{client_id}",
  • "relation_id": 154
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Can dissociate as owner

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "can_dissociate": true
}

Get Available Roles for Client

Host: https://api.fotbo.com

Retrieve available roles for the specified client.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "default_role_id": 1,
  • "roles": [
    ]
}

Get User Notifications Settings for Client

Host: https://api.fotbo.com

Retrieve user-specific notification settings for the specified client.

Authorizations:
apikey header authorization
query Parameters
preview
string
user_id
string

Responses

Response samples

Content type
application/json
{
  • "detail": {
    }
}

Get Users Associated with Client

Host: https://api.fotbo.com

Retrieve a list of users associated with the specified client.

Authorizations:
apikey header authorization

Responses

Response samples

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

Send Invitation to Client

Host: https://api.fotbo.com

Send an invitation to the specified client. You may not have access or there may not be funds on your balance to complete this operation.

Authorizations:
apikey header authorization
Request Body schema: application/json
id
required
string
required
Array of objects
roles
required
Array of integers
user_email
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "{client_id}",
  • "notifications_settings": [
    ],
  • "roles": [
    ],
  • "user_email": "[email protected]"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Get Client Creation Options

Host: https://api.fotbo.com

Retrieve options for creating a new client. Through a GET request with create_options, data about the service options is obtained before ordering it. You can see what the characteristics may be. These options must be specified when using POST/PUT requests.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ],
  • "currencies": [
    ],
  • "custom_fields": {
    }
}

Disable 2FA Method

Host: https://api.fotbo.com

Disable the Google Authenticator (2FA, SFA) method for authentication.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Enable 2FA Method

Host: https://api.fotbo.com

Enable the Google Authenticator (2FA, SFA) method for authentication.

Authorizations:
apikey header authorization
Request Body schema: application/json
verification_code
required
string

Responses

Request samples

Content type
application/json
{
  • "verification_code": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Get Google Authenticator Code

Host: https://api.fotbo.com

Retrieve the Google Authenticator code for the 2FA user.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "secret_key": "string"
}

Get 2FA Status

Host: https://api.fotbo.com

Retrieve the status of the Google Authenticator (2FA, SFA) method for the user.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "default": true,
  • "enabled": true
}

List Plugins with Component

Host: https://api.fotbo.com

Retrieve a list of plugins with a specific component.

Authorizations:
apikey header authorization
query Parameters
component_name
string

Responses

Response samples

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

2FA Types Manager

Host: https://api.fotbo.com

Manage SFA (2FA, Second Factor Authentication) types.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "objects": [
    ],
  • "pageNo": 0,
  • "previous": null,
  • "totalCount": 0
}

Check Password Confirmation Status

Host: https://api.fotbo.com

Check the status of password confirmation for 2FA/SFA types.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "allowed": true
}

Update UserProfile

Host: https://api.fotbo.com

Updating a User Profile

Authorizations:
apikey header authorization
Request Body schema: application/json
email
required
string
first_name
required
string
last_name
required
string
old_password
required
string
password
required
string
password_confirm
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "old_password": "string",
  • "password": "string",
  • "password_confirm": "string"
}

Response samples

Content type
application/json
{
  • "confirmation_email_sent": true,
  • "detail": "string"
}

List operations

Host: https://api.fotbo.com

List operations

Authorizations:
apikey header authorization
query Parameters
page_size
string
ordering
string
filtering
string
page
string
active_client
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": null,
  • "previous": null,
  • "objects": [
    ],
  • "totalCount": 0,
  • "pageNo": "string",
  • "filter_options": {
    }
}

List opearation status

Host: https://api.fotbo.com

List opearation status

Authorizations:
apikey header authorization
query Parameters
active_client
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "operation_type": "string",
  • "primary_object_id": null,
  • "status": "string",
  • "completed": true,
  • "created_at": "string",
  • "progress": {
    },
  • "initiating_user": {
    },
  • "seen": true,
  • "can_retry": true
}

Operation retry

Host: https://api.fotbo.com

Operation retry

Authorizations:
apikey header authorization
query Parameters
active_client
string

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Оperations in progress

Host: https://api.fotbo.com

Оperations in progress

Authorizations:
apikey header authorization
query Parameters
active_client
string

Responses

Response samples

Content type
application/json
{
  • "has_operations_in_progress": true,
  • "operations_count": 0,
  • "unseen_failed_operations": true
}

Mark all as read

Host: https://api.fotbo.com

Mark all as read

Authorizations:
apikey header authorization
query Parameters
active_client
string

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Tickets

The "Tickets" section offers features for managing support tickets. Users can create, track, and resolve tickets, ensuring effective communication and issue resolution.

List Ticket Departments

Host: https://api.fotbo.com

Retrieve a list of ticket departments associated with the user's account.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "count": 3,
  • "next": null,
  • "objects": [],
  • "pageNo": 1,
  • "previous": null,
  • "totalCount": 3
}

Create Ticket Attachments

Host: https://api.fotbo.com

Retrieve a list of attachments associated with tickets.

Authorizations:
apikey header authorization
Request Body schema: multipart/form-data; boundary=----WebKitFormBoundaryo5S2BC0hUAz3ywAh
Schema not provided

Responses

Request samples

Content type
multipart/form-data; boundary=----WebKitFormBoundaryo5S2BC0hUAz3ywAh
null

Response samples

Content type
application/json
{
  • "content_type": "application/octet-stream",
  • "disk_file": "322db92f-d377-4504-9d04-dffaf6c2ce43_Bing.url",
  • "email_message": null,
  • "file_name": "Bing.url",
  • "id": 149622,
  • "ticket_note": null,
  • "ticket_update": null
}

Get List Tickets

Host: https://api.fotbo.com

Retrieve a list of tickets associated with the user's account.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "filter_options": {
    },
  • "has_departments": true,
  • "next": null,
  • "objects": [
    ],
  • "pageNo": "1",
  • "previous": null,
  • "totalCount": 1
}

Add Tickets

Host: https://api.fotbo.com

Add tickets with the user's account.

Authorizations:
apikey header authorization
Request Body schema: application/json
cc_recipients_input
required
string
client
required
integer
department
required
integer
description
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "cc_recipients_input": "",
  • "client": "{client_id}",
  • "department": 1,
  • "description": "{You description}",
  • "title": "{You title}"
}

Response samples

Content type
application/json
{
  • "cc_recipients": null,
  • "client": "{client_id}",
  • "created_at": "2023-11-30T17:29:24.677129+02:00",
  • "created_by": 610858,
  • "department": 1,
  • "description": "<p>API. Checking the operation of the ticket system </p>",
  • "email_message": null,
  • "id": "371388",
  • "last_reply_at": "2023-11-30T17:29:24.677146+02:00",
  • "merged_into": null,
  • "service": null,
  • "status": "open",
  • "title": "API. Checking the operation of the ticket system.",
  • "to_recipients": "[]"
}

Get Ticket Details

Host: https://api.fotbo.com

Retrieve detailed information about a specific ticket identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "cc_recipients": null,
  • "client": "{client_id}",
  • "client_display": "Staff (John3.16 Good News) #{client_id}",
  • "created_at": "2023-11-30T08:17:26.454789Z",
  • "created_by": {
    },
  • "created_by_display": "John316 Good New",
  • "created_by_email": null,
  • "department": 1,
  • "department_display": "Technical department",
  • "department_email": "[email protected]",
  • "description": "<p>Checking the ticket system.&nbsp;</p>",
  • "id": "{ticket_id}",
  • "is_staff_generated": false,
  • "main_attachments": null,
  • "replies_and_notes": [
    ],
  • "service": null,
  • "status": "done",
  • "status_display": "Done",
  • "ticket_owner_email": "{email@owner}",
  • "title": "Checking the ticket system.",
  • "to_recipients_display": "{email@owner}"
}

Add Reply to Ticket

Host: https://api.fotbo.com

Add a reply to the specified ticket identified by ID.

Authorizations:
apikey header authorization
Request Body schema: application/json
associated_attachments
required
string
close_ticket
required
boolean
reply_text
required
string

Responses

Request samples

Content type
application/json
{
  • "associated_attachments": "",
  • "close_ticket": false,
  • "reply_text": "<p><br>\n 2. Checking the operation of the ticket system .<br>\n&nbsp;</p>"
}

Response samples

Content type
application/json
{
  • "reply_id": 546326
}

Close Ticket

Host: https://api.fotbo.com

Close the specified ticket identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "Ticket successfully closed."
}

Reopen Ticket

Host: https://api.fotbo.com

Reopen the specified ticket identified by ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "Ticket successfully reopened."
}

Notifications

The "Notifications" section focuses on notification settings and management. Users can configure notification preferences, receive alerts, and stay informed about important events and updates.

Get List Notifications

Host: https://api.fotbo.com

Retrieve a list of notifications for the user.

Authorizations:
apikey header authorization
query Parameters
filtering
string
ordering
string
page
string
page_size
string

Responses

Response samples

Content type
application/json
{
  • "count": 15,
  • "extra": {
    },
  • "filter_options": {
    },
  • "next": null,
  • "objects": [
    ],
  • "pageNo": "1",
  • "previous": null,
  • "totalCount": 1
}

Get Notification ID

Host: https://api.fotbo.com

Retrieve detailed information about a specific notification identified by its unique ID.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "body": "string",
  • "generated": "string",
  • "id": 0,
  • "status": "string",
  • "title": "string",
  • "top_line_background_color": "string",
  • "top_line_text_color": "string"
}

Mark Notification as Unseen

Host: https://api.fotbo.com

Mark a specific notification as unseen, indicating that the user has not viewed it.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Mark Notification as Viewed

Host: https://api.fotbo.com

Mark a specific notification as viewed, indicating that the user has seen the notification.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Get Notification Settings

Host: https://api.fotbo.com

Retrieve user-specific notification settings.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": {
    }
}

All Notifications - Read

Host: https://api.fotbo.com

Mark all user notifications as read.

Authorizations:
apikey header authorization

Responses

Response samples

Content type
application/json
{
  • "detail": "All notifications were marked as read."
}