openapi: 3.0.0 info: title: 'eCloud API' version: 2.0.0 servers: - url: 'https://api.ukfast.io' paths: /ecloud/v2/affinity-rules: get: tags: - 'Affinity Rules' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: ar-2b66bb79 name: type: string readOnly: false example: 'Affinity Rule 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true type: type: string readOnly: false example: anti-affinity required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rules' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules?page=2' post: tags: - 'Affinity Rules' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: ar-2b66bb79 name: type: string readOnly: false example: 'Affinity Rule 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true type: type: string readOnly: false example: anti-affinity required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rules' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ar-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/ar-3f112f25' '/ecloud/v2/affinity-rules/{AffinityRuleId}': get: tags: - 'Affinity Rules' parameters: - name: id in: path required: true schema: type: string example: ar-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: ar-2b66bb79 name: type: string readOnly: false example: 'Affinity Rule 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true type: type: string readOnly: false example: anti-affinity required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rules' meta: type: object delete: tags: - 'Affinity Rules' parameters: - name: id in: path required: true schema: type: string example: ar-3f112f25 responses: '202': description: Accepted patch: tags: - 'Affinity Rules' parameters: - name: id in: path required: true schema: type: string example: ar-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: ar-2b66bb79 name: type: string readOnly: false example: 'Affinity Rule 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true type: type: string readOnly: false example: anti-affinity required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rules' - type: object properties: availability_zone_id: readOnly: true vpc_id: readOnly: true type: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ar-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/ar-3f112f25' /ecloud/v2/affinity-rules/members: get: tags: - 'Affinity Rule Members' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: arm-2b66bb79 instance_id: type: string readOnly: false example: i-4c63cf58 affinity_rule_id: type: string readOnly: false example: ar-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rule Members' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/{AffinityRuleId}/members?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/{AffinityRuleId}/members?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/{AffinityRuleId}/members?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/{AffinityRuleId}/members?page=2' post: tags: - 'Affinity Rule Members' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: arm-2b66bb79 instance_id: type: string readOnly: false example: i-4c63cf58 affinity_rule_id: type: string readOnly: false example: ar-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rule Members' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: arm-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/ar-3f112f25/members' '/ecloud/v2/affinity-rule-members/{AffinityRuleMemberId}': get: tags: - 'Affinity Rule Members' parameters: - name: id in: path required: true schema: type: string example: arm-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: arm-2b66bb79 instance_id: type: string readOnly: false example: i-4c63cf58 affinity_rule_id: type: string readOnly: false example: ar-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rule Members' meta: type: object post: tags: - 'Affinity Rule Members' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: arm-2b66bb79 instance_id: type: string readOnly: false example: i-4c63cf58 affinity_rule_id: type: string readOnly: false example: ar-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rule Members' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: arm-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/affinity-rules/ar-3f112f25/members' delete: tags: - 'Affinity Rule Members' parameters: - name: id in: path required: true schema: type: string example: arm-3f112f25 responses: '202': description: Accepted /ecloud/v2/availability-zones: get: tags: - 'Availability Zones' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: az-2b66bb79 code: type: string example: MAN1 name: type: string example: 'Manchester Region 1' datacentre_site_id: type: integer example: 999 region_id: type: string readOnly: true example: reg-2b66bb79 resource_tier_id: type: string description: 'ID of the default resource tier for the availability zone' readOnly: true example: rt-abc123 state: type: string description: 'Determines whether the availability zone is deployable into, e.g., active, maintenance, deprecated' example: active features: type: array items: type: string example: advanced_networking description: 'List of features enabled for this availability zone' description: 'Availability Zones' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones?page=2' '/ecloud/v2/availability-zones/{AvailabilityZoneId}': get: tags: - 'Availability Zones' parameters: - name: AvailabilityZoneId in: path required: true schema: type: string example: az-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: az-2b66bb79 code: type: string example: MAN1 name: type: string example: 'Manchester Region 1' datacentre_site_id: type: integer example: 999 region_id: type: string readOnly: true example: reg-2b66bb79 resource_tier_id: type: string description: 'ID of the default resource tier for the availability zone' readOnly: true example: rt-abc123 state: type: string description: 'Determines whether the availability zone is deployable into, e.g., active, maintenance, deprecated' example: active features: type: array items: type: string example: advanced_networking description: 'List of features enabled for this availability zone' description: 'Availability Zones' meta: type: object '/ecloud/v2/availability-zones/{AvailabilityZoneId}/router-throughputs': get: tags: - 'Availability Zones' parameters: - name: AvailabilityZoneId in: path required: true schema: type: string example: az-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: rtp-2b66bb79 availability_zone_id: type: string description: 'The Availability Zone that this router throughput option is available on' example: az-2b66bb79 required: true name: type: string example: 10Gb required: false committed_bandwidth: type: integer description: 'Bandwidth in Mbps' example: 10240 required: true description: 'Router Throughput' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/router-throughputs?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/router-throughputs?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/router-throughputs?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/router-throughputs?page=2' '/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices': get: tags: - 'Availability Zones' parameters: - name: AvailabilityZoneId in: path required: true schema: type: string example: az-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: availability_zone_id: type: string example: az-2b66bb79 name: type: string example: ram description: type: string description: 'Description of the product' example: '1GB RAM (upto 24GB)' category: type: string description: 'Product category, one of compute / storage / networking / license / support' example: compute price: description: 'Price of this product in the stated availability zone.' example: '0.958904' type: null rate: type: string description: 'The rate / frequency that applies to the specified price.' example: hour meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=2' '/ecloud/v2/availability-zones/{AvailabilityZoneId}/resource-tiers': get: tags: - 'Availability Zones' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: rt-2b66bb79 name: type: string readOnly: false example: 'Resource Tier 1' required: false description: type: string readOnly: false example: 'Resource Tier 1 description' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true cpu: type: object properties: min: type: integer description: 'Minimum total VCPU cores allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum total VCPU cores allowed for instance on this tier' example: 10 readOnly: true cpu_sockets: type: object properties: min: type: integer description: 'Minimum VCPU sockets allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum VCPU sockets allowed for instance on this tier' example: 10 readOnly: true ram: type: object properties: min: type: integer description: 'Minimum RAM MiB allowed for instance on this tier' example: 1024 max: type: integer description: 'Maximum RAM MiB allowed for instance on this tier' example: 131072 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Resource Tiers' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=2' '/ecloud/v2/availability-zones/{AvailabilityZoneId}/iops': get: tags: - 'Availability Zones' parameters: - name: AvailabilityZoneId in: path required: true schema: type: string example: az-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: iops-2b66bb79 name: type: string readOnly: true example: '300 Iops' required: false level: type: integer readOnly: true example: 300 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Iops meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/iops?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/iops?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/iops?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/iops?page=2' '/ecloud/v2/availability-zones/{AvailabilityZoneId}/vpn-gateway-specifications': get: tags: - 'Availability Zones' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vgws-2b66bb79 name: type: string readOnly: true example: 'Vpn Gateway Specification Name' description: type: string readOnly: true example: 'Description of the Vpn Gateway Specification' max_users: type: integer description: 'Maximum number of users that can be connected to the Vpn Gateway' readOnly: true example: 10 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway Specification' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/vpn-gateway-specifications?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/vpn-gateway-specifications?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/vpn-gateway-specifications?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/vpn-gateway-specifications?page=2' /ecloud/v2/backup-gateways: get: tags: - 'Backup Gateways' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: bgw-12356 name: type: string example: 'Backup Gateway' required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router assigned to backup gateway' readOnly: true example: rtr-2b66bb79 required: false network_id: type: string description: 'Network assigned to the backup gateway' readOnly: false example: net-abc123 required: true gateway_spec_id: type: string description: 'Gateway spec id assigned to backup gateway' readOnly: false example: bgws-5635 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Backup Gateways' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/backup-gateways?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/backup-gateways?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/backup-gateways?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/backup-gateways?page=2' post: tags: - 'Backup Gateways' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: bgw-12356 name: type: string example: 'Backup Gateway' required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router assigned to backup gateway' readOnly: true example: rtr-2b66bb79 required: false network_id: type: string description: 'Network assigned to the backup gateway' readOnly: false example: net-abc123 required: true gateway_spec_id: type: string description: 'Gateway spec id assigned to backup gateway' readOnly: false example: bgws-5635 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Backup Gateways' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: bgw-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/backup-gateways/bgw-6ui8gt89' '/ecloud/v2/backup-gateways/{backupGatewayId}': get: tags: - 'Backup Gateways' parameters: - name: id in: path required: true schema: type: string example: bgw-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: bgw-12356 name: type: string example: 'Backup Gateway' required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router assigned to backup gateway' readOnly: true example: rtr-2b66bb79 required: false network_id: type: string description: 'Network assigned to the backup gateway' readOnly: false example: net-abc123 required: true gateway_spec_id: type: string description: 'Gateway spec id assigned to backup gateway' readOnly: false example: bgws-5635 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Backup Gateways' meta: type: object delete: tags: - 'Backup Gateways' parameters: - name: id in: path required: true schema: type: string example: bgw-3f112f25 responses: '202': description: Accepted patch: tags: - 'Backup Gateways' parameters: - name: id in: path required: true schema: type: string example: bgw-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: bgw-12356 name: type: string example: 'Backup Gateway' required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router assigned to backup gateway' readOnly: true example: rtr-2b66bb79 required: false network_id: type: string description: 'Network assigned to the backup gateway' readOnly: false example: net-abc123 required: true gateway_spec_id: type: string description: 'Gateway spec id assigned to backup gateway' readOnly: false example: bgws-5635 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Backup Gateways' - type: object properties: vpc_id: readOnly: true required: false availability_zone_id: readOnly: true required: false router_id: readOnly: true required: false network_id: readOnly: true required: false gateway_spec_id: readOnly: true required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: bgw-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/backup-gateways/bgw-6ui8gt89' /ecloud/v2/billing-history: get: tags: - 'Billing History' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: bh-1a2b3c4d billing_period_start: type: string example: '2020-07-07T10:30:00+01:00' required: true billing_period_end: type: string example: '2020-07-07T10:30:00+01:00' required: false consumption_total: type: float example: 999.99 plan_spend_limit: type: float example: 999.99 plan_overage: type: float example: 999.99 created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing History' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/billing-history?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/billing-history?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/billing-history?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/billing-history?page=2' '/ecloud/v2/billing-history/{billingHistoryId}': get: tags: - 'Billing History' parameters: - name: billingHistoryId in: path required: true schema: type: string example: bh-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: bh-1a2b3c4d billing_period_start: type: string example: '2020-07-07T10:30:00+01:00' required: true billing_period_end: type: string example: '2020-07-07T10:30:00+01:00' required: false consumption_total: type: float example: 999.99 plan_spend_limit: type: float example: 999.99 plan_overage: type: float example: 999.99 created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing History' meta: type: object /ecloud/v2/billing-history-items: get: tags: - 'Billing History Items' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: bhi-1a2b3c4d billing_history_id: type: string readOnly: false example: bh-aaaaaaaa required: true vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true client_id: type: integer description: 'The ID of the client this resource is assigned to.' readOnly: true example: 123 category: type: string description: 'The category of the resource.' example: Compute required: true key: type: string example: ram.capacity required: true value: type: string example: 16GB required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing History Item' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/billing-history-items?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/billing-history-items?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/billing-history-items?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/billing-history-items?page=2' '/ecloud/v2/billing-history-items/{billingHistoryItemId}': get: tags: - 'Billing History Items' parameters: - name: billingHistoryItemId in: path required: true schema: type: string example: bhi-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: bhi-1a2b3c4d billing_history_id: type: string readOnly: false example: bh-aaaaaaaa required: true vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true client_id: type: integer description: 'The ID of the client this resource is assigned to.' readOnly: true example: 123 category: type: string description: 'The category of the resource.' example: Compute required: true key: type: string example: ram.capacity required: true value: type: string example: 16GB required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing History Item' meta: type: object /ecloud/v2/billing-metrics: get: tags: - 'Billing Metric' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: bm-1a2b3c4d name: type: string example: RAM resource_id: type: string example: i-1a2b3c4d required: true resource_name: type: string readOnly: true example: 'Instance 1' vpc_id: type: string example: vpc-1a2b3c4d required: true vpc_name: type: string example: 'VPC 1' required: true key: type: string example: ram.capacity required: true value: type: string example: 16GB required: true start: type: string example: '2020-07-07T10:30:00+01:00' required: true end: type: string example: '2020-07-07T10:30:00+01:00' required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing Metric' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/billing-metrics?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/billing-metrics?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/billing-metrics?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/billing-metrics?page=2' '/ecloud/v2/billing-metrics/{billingMetricsId}': get: tags: - 'Billing Metric' parameters: - name: billingMetricId in: path required: true schema: type: string example: bm-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: bm-1a2b3c4d name: type: string example: RAM resource_id: type: string example: i-1a2b3c4d required: true resource_name: type: string readOnly: true example: 'Instance 1' vpc_id: type: string example: vpc-1a2b3c4d required: true vpc_name: type: string example: 'VPC 1' required: true key: type: string example: ram.capacity required: true value: type: string example: 16GB required: true start: type: string example: '2020-07-07T10:30:00+01:00' required: true end: type: string example: '2020-07-07T10:30:00+01:00' required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Billing Metric' meta: type: object /ecloud/v2/dhcps: get: tags: - Dhcps parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: required: [] properties: id: type: string readOnly: true example: dhcp-2b66bb79 name: type: string readOnly: false example: 'My DHCP' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Dhcps meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/dhcps?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/dhcps?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/dhcps?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/dhcps?page=2' '/ecloud/v2/dhcps/{dhcpId}': get: tags: - Dhcps parameters: - name: dhcpId in: path required: true schema: type: string example: dhcp-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: required: [] properties: id: type: string readOnly: true example: dhcp-2b66bb79 name: type: string readOnly: false example: 'My DHCP' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Dhcps meta: type: object '/ecloud/v2/dhcps/{dhcpId}/tasks': get: tags: - Dhcps parameters: - name: dhcpId in: path required: true schema: type: string example: dhcp-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/dhcps/{dhcpId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/dhcps/{dhcpId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/dhcps/{dhcpId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/dhcps/{dhcpId}/tasks?page=2' /ecloud/v2/discount-plans: get: tags: - 'Discount Plans' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: disc-2b66bb79 name: type: string example: 'Discount Plan Name' commitment_amount: type: float example: 999.99 commitment_before_discount: type: float example: 999.99 discount_rate: type: float description: 'Numeric percentage discount' example: 5.5 term_length: type: integer description: 'term duration in months' example: 24 term_start_date: type: string example: '2020-07-07T10:30:00+01:00' term_end_date: type: string example: '2020-07-07T10:30:00+01:00' status: type: string example: accepted response_date: type: string example: '2020-07-07T10:30:00+01:00' is_trial: type: boolean readOnly: true example: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Discount Plans' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/discount-plans?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/discount-plans?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/discount-plans?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/discount-plans?page=2' '/ecloud/v2/discount-plans/{discountPlanId}': get: tags: - 'Discount Plans' parameters: - name: DiscountPlanId in: path required: true schema: type: string example: disc-2b66bb79 responses: '200': description: success content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: disc-2b66bb79 name: type: string example: 'Discount Plan Name' commitment_amount: type: float example: 999.99 commitment_before_discount: type: float example: 999.99 discount_rate: type: float description: 'Numeric percentage discount' example: 5.5 term_length: type: integer description: 'term duration in months' example: 24 term_start_date: type: string example: '2020-07-07T10:30:00+01:00' term_end_date: type: string example: '2020-07-07T10:30:00+01:00' status: type: string example: accepted response_date: type: string example: '2020-07-07T10:30:00+01:00' is_trial: type: boolean readOnly: true example: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Discount Plans' '/ecloud/v2/discount-plans/{discountPlanId}/approve': post: tags: - 'Discount Plans' parameters: - name: DiscountPlanId in: path required: true schema: type: string example: disc-2b66bb79 responses: '200': description: Success '/ecloud/v2/discount-plans/{discountPlanId}/reject': post: tags: - 'Discount Plans' parameters: - name: DiscountPlanId in: path required: true schema: type: string example: disc-2b66bb79 responses: '200': description: Success /ecloud/v2/firewall-policies: get: tags: - 'Firewall Policies' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies?page=2' post: tags: - 'Firewall Policies' requestBody: content: application/json: schema: allOf: - properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies - properties: router_id: type: string readOnly: false example: rtr-4c63cf58 required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwp-4f22694 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/fwp-4f22694' '/ecloud/v2/firewall-policies/{firewallPolicyId}': get: tags: - 'Firewall Policies' parameters: - name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies meta: type: object delete: tags: - 'Firewall Policies' parameters: - name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 responses: '202': description: Accepted patch: tags: - 'Firewall Policies' parameters: - name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies - type: object properties: name: required: false router_id: required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwp-4f22694 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/fwp-4f22694' '/ecloud/v2/firewall-policies/{firewallPolicyId}/firewall-rules': get: tags: - 'Firewall Policies' parameters: - name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/firewall-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/firewall-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/firewall-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/firewall-rules?page=2' '/ecloud/v2/firewall-policies/{firewallPolicyId}/tasks': get: tags: - 'Firewall Policies' parameters: - name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/{firewallPolicyId}/tasks?page=2' /ecloud/v2/firewall-rule-ports: get: tags: - 'Firewall Rule Ports' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false firewall_rule_id: type: string readOnly: false example: fwr-abc123xyz required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Firewall Rule Ports' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=2' post: tags: - 'Firewall Rule Ports' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: fwrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false firewall_rule_id: type: string readOnly: false example: fwr-abc123xyz required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Firewall Rule Ports' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwrp-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports/fwrp-3f112f25' '/ecloud/v2/firewall-rule-ports/{firewallRulePortId}': get: tags: - 'Firewall Rule Ports' parameters: - name: firewallRulePortId in: path required: true schema: type: string example: fwrp-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: fwrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false firewall_rule_id: type: string readOnly: false example: fwr-abc123xyz required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Firewall Rule Ports' meta: type: object delete: tags: - 'Firewall Rule Ports' parameters: - name: firewallRulePortId in: path required: true schema: type: string example: fwrp-3f112f25 responses: '202': description: Accepted patch: tags: - 'Firewall Rule Ports' parameters: - name: firewallRulePortId in: path required: true schema: type: string example: fwrp-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: fwrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false firewall_rule_id: type: string readOnly: false example: fwr-abc123xyz required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Firewall Rule Ports' - type: object properties: firewall_rule_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwrp-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports/fwrp-3f112f25' /ecloud/v2/firewall-rules: get: tags: - 'Firewall Rules' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-rules?page=2' post: tags: - 'Firewall Rules' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwr-cd22694 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-rules/fwr-cd22694' '/ecloud/v2/firewall-rules/{firewallRuleId}': get: tags: - 'Firewall Rules' parameters: - name: firewallRuleId in: path required: true schema: type: string example: fwr-cd226940 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules meta: type: object delete: tags: - 'Firewall Rules' parameters: - name: firewallRuleId in: path required: true schema: type: string example: fwr-cd226940 responses: '202': description: Accepted patch: tags: - 'Firewall Rules' parameters: - name: firewallRuleId in: path required: true schema: type: string example: fwr-cd226940 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules - type: object properties: firewall_policy_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwr-cd22694 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-rules/fwr-cd22694' '/ecloud/v2/firewall-rules/{firewallRuleId}/ports': get: tags: - 'Firewall Rules' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false firewall_rule_id: type: string readOnly: false example: fwr-abc123xyz required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Firewall Rule Ports' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/firewall-rule-ports?page=2' /ecloud/v2/floating-ips: get: tags: - 'Floating IPs' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/floating-ips?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/floating-ips?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/floating-ips?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/floating-ips?page=2' post: tags: - 'Floating IPs' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fip-cd22694 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/floating-ips/fip-cd22694' '/ecloud/v2/floating-ips/{fipId}': get: tags: - 'Floating IPs' parameters: - name: fipId in: path required: true schema: type: string example: fip-cd226940 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' meta: type: object delete: tags: - 'Floating IPs' responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'Floating IPs' parameters: - name: fipId in: path required: true schema: type: string example: fip-cd226940 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' - type: object properties: vpc_id: readOnly: true availability_zone_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fip-cd22694 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/floating-ips/fip-cd22694' '/ecloud/v2/floating-ips/{fipId}/assign': post: tags: - 'Floating IPs' parameters: - name: fipId in: path required: true schema: type: string example: fip-cd226940 requestBody: content: application/json: schema: type: object properties: resource_id: type: string description: 'The ID of the resource to assign the floating IP to.' example: nic-abc123 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fip-cd22694 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/floating-ips/fip-cd22694' '/ecloud/v2/floating-ips/{fipId}/tasks': get: tags: - 'Floating IPs' parameters: - name: fipId in: path required: true schema: type: string example: fip-cd226940 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/floating-ips/{fipId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/floating-ips/{fipId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/floating-ips/{fipId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/floating-ips/{fipId}/tasks?page=2' '/ecloud/v2/floating-ips/{fipId}/unassign': post: tags: - 'Floating IPs' parameters: - name: fipId in: path required: true schema: type: string example: fip-cd226940 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fip-cd22694 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/floating-ips/fip-cd22694' /ecloud/v2/images: get: tags: - Images parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'CentOS 7' logo_uri: type: string readOnly: true example: 'https://example.com/image.png' documentation_uri: type: string readOnly: true example: 'https://example.com/docs' vpc_id: type: string description: 'ID of the VPC that the image is assigned to for private images' readOnly: true example: vpc-abc123 description: type: string readOnly: true example: 'Linux operating system' visibility: type: string readOnly: true example: public image_size: type: integer readOnly: true example: 60 platform: type: string readOnly: true example: Linux sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true description: Images meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/images?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/images?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/images?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/images?page=2' '/ecloud/v2/images/{id}': get: tags: - Images parameters: - name: id in: path required: true schema: type: string example: img-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'CentOS 7' logo_uri: type: string readOnly: true example: 'https://example.com/image.png' documentation_uri: type: string readOnly: true example: 'https://example.com/docs' vpc_id: type: string description: 'ID of the VPC that the image is assigned to for private images' readOnly: true example: vpc-abc123 description: type: string readOnly: true example: 'Linux operating system' visibility: type: string readOnly: true example: public image_size: type: integer readOnly: true example: 60 platform: type: string readOnly: true example: Linux sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true description: Images meta: type: object delete: tags: - Images parameters: - name: id in: path required: true schema: type: string example: img-2b66bb79 responses: '202': description: Accepted patch: tags: - Images parameters: - name: id in: path required: true schema: type: string example: img-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'CentOS 7' logo_uri: type: string readOnly: true example: 'https://example.com/image.png' documentation_uri: type: string readOnly: true example: 'https://example.com/docs' vpc_id: type: string description: 'ID of the VPC that the image is assigned to for private images' readOnly: true example: vpc-abc123 description: type: string readOnly: true example: 'Linux operating system' visibility: type: string readOnly: true example: public image_size: type: integer readOnly: true example: 60 platform: type: string readOnly: true example: Linux sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true description: Images - type: object properties: name: readOnly: false description: readOnly: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: img-2b66bb79 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79' '/ecloud/v2/images/{id}/metadata': get: tags: - Images parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: imgparam-abc123xyz image_id: type: string readOnly: true example: img-2b66bb79 key: type: string readOnly: true example: ukfast.spec.ram.min value: type: string readOnly: true example: '1024' description: 'Image Parameters' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/metadata?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/metadata?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/metadata?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/metadata?page=2' '/ecloud/v2/images/{id}/parameters': get: tags: - Images parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: imgparam-abc123xyz image_id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'MySQL root password' key: type: string readOnly: true example: mysql_root_password type: type: string readOnly: true example: Password description: type: string readOnly: true example: 'The root password for the MySQL database' required: type: boolean readOnly: true example: true validation_rule: type: string readOnly: true example: /\\w+/ description: 'Image Parameters' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/parameters?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/parameters?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/parameters?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/images/img-2b66bb79/parameters?page=2' '/ecloud/v2/images/{id}/software': get: tags: - Images parameters: - name: id in: path required: true schema: type: string example: img-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: soft-2b66bb79 name: type: string readOnly: false example: Mcafee required: false platform: type: string readOnly: false example: Linux required: true description: Software meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/images/{imageId}/software?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/images/{imageId}/software?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/images/{imageId}/software?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/images/{imageId}/software?page=2' /ecloud/v2/instances: get: tags: - Instances parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances?page=2' post: tags: - Instances requestBody: content: application/json: schema: allOf: - properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances - properties: volume_group_id: readOnly: true encrypt: type: boolean writeOnly: true example: false required: false enable_monitoring: type: boolean description: 'Not available if passing monitoring_enabled' writeOnly: true example: false required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: i-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/instances/i-6ui8gt89' '/ecloud/v2/instances/{instanceId}': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: allOf: - properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances - type: object properties: online: type: boolean readOnly: true example: true agent_running: type: boolean readOnly: true example: true meta: type: object delete: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: with_floating_ips: type: boolean description: 'When set to true, floating IPs associated with the instance will also be deleted' default: false example: true description: 'Instance deletion options' required: false responses: '202': description: Accepted patch: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: name: type: string example: 'My Instance' required: false vcpu_cores: type: integer example: 1 required: false ram_capacity: type: integer description: 'RAM capacity MiB' example: 1024 required: false description: Instances required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: i-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/instances/i-6ui8gt89' '/ecloud/v2/instances/{instanceId}/console-screensot': get: tags: - Instances description: 'Take a screenshot of the console' parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: success content: image/png: schema: type: string format: base64 example: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAJYCAIAAAAVFBUnAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAA4mSURBVHhe7dtRciNHsgRA3f8oOuUrQxZyk1lVjQYHIz2O3D/WIqITTWk/CNqa7V8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMD/H38Xc/qu9Q3x2jTX8741jx7m9NXFo98hflwzn72yHscS5vRRv+/NAMBe/fat+RvWj7cla4bQ6tb1zfXTj2s/rtUL62Vdav6s3/dmAKBbv3d/5Wt4+7a6ZM0QWt26c/NvufnPtp5tl5k+bf1ZAMBvcfGlG49SHevTuld1jzzUWvMdF/fxaJi9HEcY2n6Rw7pcuHm8nq1LikepjvVp7MPsT3MtTjsA8GGnL92213rKQ6tDW7Z1mP3S9eX6tC6ZM7Q81FrzS/eP18t1CW2vNfJQ9wyh1bAdAYDPO33pxt7UR2seWh3a0mrYjqvrs/VpXTJnaDnEEub0yi8er0toe63bHKGJm7QdAYDPO33pnvahPqp5aHVoS6vptFfXN+vTumTO0HLajidvHQ/r/bqEttdac9qOzZ0bAOAD1i/dqOue6qOah1aHtmTNEFrdajftvj0d6pI5Q8shljCnS/cvw3q/XeI/615rzWk7NnduAIDPqN+7mTOEWk95yLqGkDVDaHWr3tQcrpfMGVoeaq35ws2zav1IXTJnCLXWnNrY6rAuAMDvFd++YU5fx2GuX7+qaw6xDLO/ek+a68E8+mo++/p0Ts/xlIe6Z0jrsrpzs1o/FUuY09dxWMdY0lyf5vqwLgAAAAAAAAAAAAAAAAAAAMDb4v/AP9Qa+R8QP26Y/dI8fZrrK+txLGmuZ/Puaa6vnI63e4zD7A9zeprrpXl6+x9yePd+K14yzL78w4f57E3zw09zfZjT7TfP68P9xaOfKP510lwf5uS/N4Dfqv5+rPmfcfMntrNWT+JsmP3997SDVk/ibJj9aa5f93UZ2tjq1p2bJj4yzP4L2nuu633tg7XWfMf1fTwdZv/h2r9LrTXfcX0fT4fZAUj192PN/4zv/cQ7n4qbMKflg62u2kGrW3ET5vQwp4c5nV/Y9lZXLw9W8ZEwp19w/Z7rpxfaB7NmuOn6Pp6GOf1w7d8la4abru/jaZgTACl/P2YIUVMd69PrfZj9aa5P2/Gl+59ql7VGHqJu1YPIQ9Rrp8u2t5rqHnmIuvXy4OT+B+MyzfVpO6brp8N6EEuYUznLcNPFfT7KcC3OUh3r09gvzLuHOb3/nvUmljCn5bUx3nFxn48yAPBF/H4Mc1p+adYaedjuLWcIrQ7rciGOw5xeacdZI4R4tJUHEUI8una6bHvUqu7tIB5tzYtiPnjl5nE7a3VYl3TxqKpna07bcYj9ZB4VdV/zSbup9ZRfase11nxSb9actuMQ+8k8Kuq+ZgD+J34/hjntfrEO9dHNHKGJm7Aud9z/VLuMGrLGo604CFnXRyH2sC6h7acaIdT9pB20euHmZZw189nDuoTTvhXHoS6Rh6wZQqurdpA1QhM3W+2g1lM+iZs01/ffM8RZqEvkIWuG0OqqHWSN0MQNAFP+cszQcnN6VPfMGU5eHmzd/1S7jDrUGnkrDoZaI187Xbb9VCMMbT9pB61euHn58mx7sB2vtY+caobQ6qodtBq2Y9Nuaj3lrXpQ81Brzdfa5almCK2u2kGrYTsC8OX3Y+YMq9OjumfOcPLyYOv+p9rldV21g1YvnC7bfqoZQqurdtDqhZuXL8+2B9vxQtyHukQesmYIra7aQathOzbtptZT3qoHNQ+11nwhzkJdIg9ZM4RWV+2g1bAdAfjy+zFzhlBrzVXdM2cIrQ7rstXOWh3WJbT9ug5tua4XTpdtP9UModWhLdd1WJdwc7+uw7oM2zGsj+qSOUPImiG0umoHrYbt2LSbWk95qx7UPNRa80m9yZwhZM0QWl21g1bDdgT4r4tfjkOtNad1jCXVcc0pxjCnhzmdzbunuT6tYyzVdo8xrWMsaa5n8654a49xmP1prk/rGEua69M6xlLNBw+nJc31YU4Pc3pYl9QetTrkEiHF02H2p7mezbunuT7N9WFOB/Poaa7Pfc0ncTNkrvuat9aDXCKkeDrM/jTXs3n3NNenuT7MCQAAAIAr839LWczHHMz/mhbzMQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8Gl/P8yy1GFdrr11vGo/rtVfFy8Mc/qW+YqP/rMBAH+I9ldCq8O6XHjreCveMNQa+VM+9c5PvQcA+NO0vxJafdfFxy8eVXEWssajT/nUOz/1HgDgT9P+StjWYfZyEGGoexV72o6rOGtyrzc1D7VGPjndxJ7m+mpf80ncpDrWp7EDAD/Y/Fb/aj57uF5qHlr9hnxDhFD3bV7F063tQRuzZgi1Zs5wod3UesoAwE/VvtFbHa6XmodWv6G+IfKw3Vtew8n2oI1ZM6ziUZjTWTur9ZQBgJ+qfaO3OlwvNQ+tfkN7Q9YMp7yGk+1BG7NmWMWjMKezdlbrKQMAP1X7Rm91uF5qHlqtLh5V7SxrhlNew0k7iLyOUTOs8lGGC+2m1lMGAH6q9o3e6nC91DxkzZDWZaudZc1wyms4qQeZM4SsGUKtp7zVDmo9ZQDgp2rf6Nsa5vTqD4JYhtnf1D5ba+Sh7hdhK54220cxDrM/tbHWyCdxk+b69bM1AwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD8q/5+mOVSXKa5Ps313j6nMs5++U/y8qD6xvEw+y/41HsAgB/s5h8E7azVsB2HtreaTnuIp8Psl+bpvePw7v3Jp94DAPznbP+M2I5D3WtuXj4Kczqbdw9zuuHd+0/5t34uAPC7xLf7MPs960diCXN6mNNDXSI38SjM6SGXDCFqmFNx2k/W+1jSXMueOfYh6jB7OYgwxJ62IwDws737Bb/e55IhZM2QuYp9yJrhIlfbfTteaPenmqHltI51qRkA+GOtX/mxVPPBO3893MlDrdscoak3Kca0HS+0+1PN0HJax7rUDAD8se5/5W8v6/huHmo95VTHU07b8UK7P9UMLad1rEvNAMAf6+ZX/ums7u/modZTTnU85bQdL7T7U83QclrHutQc1gUA+PFufsG3s6wZvpGHWk851fGU03a80O5PNUPLaR3rUnNYFwDgZ4tv9zCng3n0VXuU+eYeYhxmf5rr01wf2pK57Sn2C/PuYU7Le+Z63oc5PczpOa4ZAIDOX0sAAB9Q/6iqGQCA74u/q8Kcfr/58xbzMQAA75p/Ty3mYwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgP+Yv/76PzfVk3jDIkP2AAAAAElFTkSuQmCC' '/ecloud/v2/instances/{instanceId}/console-session': post: tags: - Instances description: 'Retrieve a Console Session' parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: url: type: string example: 'https:\/\/185.197.63.87\/console\/?title=idi-2b66bb79&session=cdfa6d4d-e43a-43c9-a910-9e8308105fd2' meta: type: object '/ecloud/v2/instances/{instanceId}/create-image': post: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: name: type: string example: 'Custom Centos 8 Image' required: true description: Instances required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' '/ecloud/v2/instances/{instanceId}/credentials': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: cred-2b66bb79 name: type: string example: 'Instance Credentials' required: false resource_id: type: string example: i-a63dd78c required: true host: type: string required: false username: type: string required: true password: type: string required: true port: type: integer example: 8080 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Credential meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/credentials?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/credentials?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/credentials?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/credentials?page=2' '/ecloud/v2/instances/{instanceId}/decrypt': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/encrypt': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/lock': put: tags: - Instances description: 'Lock / Unlock an instance to changes' parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '204': description: success '/ecloud/v2/instances/{instanceId}/migrate': post: tags: - Instances description: 'Migrate an instance to a new host group' parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: host_group_id: type: string description: 'ID of the destinaton private host group' example: hg-abc123 required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: i-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/instances/i-6ui8gt89' '/ecloud/v2/instances/{instanceId}/nics': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nic-2b66bb79 name: type: string example: 'Nic 1' required: false mac_address: type: string readOnly: false example: '3D:F2:C9:A6:B3:4F' required: true instance_id: type: string readOnly: false example: i-2b66bb79 required: true network_id: type: string readOnly: false example: net-2b66bb79 required: true ip_address: type: string description: 'DHCP IP Address' readOnly: true example: 10.0.0.5 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Nics meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/nics?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/nics?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/nics?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/nics?page=2' '/ecloud/v2/instances/{instanceId}/power-off': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/power-on': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/power-reset': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/power-restart': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/power-shutdown': put: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/software': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: soft-2b66bb79 name: type: string readOnly: false example: Mcafee required: false platform: type: string readOnly: false example: Linux required: true description: Software meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/software?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/software?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/software?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/software?page=2' '/ecloud/v2/instances/{instanceId}/tasks': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=2' '/ecloud/v2/instances/{instanceId}/floating-ips': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/{instanceId}/tasks?page=2' '/ecloud/v2/instances/{instanceId}/unlock': put: tags: - Instances description: 'Lock / Unlock an instance to changes' parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '204': description: success '/ecloud/v2/instances/{instanceId}/volume-attach': post: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: volume_id: type: string example: vol-abcdef12 required: true description: Instances required: true responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/volume-detach': post: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: volume_id: type: string example: vol-abcdef12 required: true description: Instances required: true responses: '202': description: Accepted '/ecloud/v2/instances/{instanceId}/user-script': post: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 requestBody: content: application/json: schema: type: object properties: script: type: string description: 'The script to be executed on the instance.' example: '' required: true username: type: string description: 'Username of a user on the instance to be used to run the script.' example: root required: true password: type: string description: 'Password for the user on the instance to be used to run the script.' example: SeCuRePaSsWoRd required: true description: Instances required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' '/ecloud/v2/instances/{instanceId}/volumes': get: tags: - Instances parameters: - name: instanceId in: path required: true schema: type: string example: i-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/volumes?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/volumes?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/volumes?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instances/i-a63dd78c/volumes?page=2' /ecloud/v2/instance-software: get: tags: - 'Instance Software' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: is-2b66bb79 name: type: string readOnly: false example: Mcafee required: false instance_id: type: string description: 'The ID of the instance that the software is associated with' readOnly: false example: i-4c63cf58 required: true software_id: type: string description: 'The ID of the software that the instance is associated with' readOnly: false example: soft-4c63cf58 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Instance Software' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/instance-software?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/instance-software?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/instance-software?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/instance-software?page=2' '/ecloud/v2/instance-software/{instanceSoftwareId}': get: tags: - 'Instance Software' parameters: - name: id in: path required: true schema: type: string example: is-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: is-2b66bb79 name: type: string readOnly: false example: Mcafee required: false instance_id: type: string description: 'The ID of the instance that the software is associated with' readOnly: false example: i-4c63cf58 required: true software_id: type: string description: 'The ID of the software that the instance is associated with' readOnly: false example: soft-4c63cf58 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Instance Software' meta: type: object /ecloud/v2/iops: get: tags: - Iops parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object allOf: - properties: id: type: string readOnly: true example: iops-2b66bb79 name: type: string readOnly: true example: '300 Iops' required: false level: type: integer readOnly: true example: 300 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Iops - type: object properties: active: readOnly: true meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/iops?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/iops?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/iops?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/iops?page=2' '/ecloud/v2/iops/{iopsId}': get: tags: - Iops parameters: - name: iopsId in: path required: true schema: type: string example: iops-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: iops-2b66bb79 name: type: string readOnly: true example: '300 Iops' required: false level: type: integer readOnly: true example: 300 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Iops meta: type: object /ecloud/v2/ip-addresses: get: tags: - 'IP Addresses' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/ip-addresses?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/ip-addresses?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/ip-addresses?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/ip-addresses?page=2' post: tags: - 'IP Addresses' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ip-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/ip-addresses/ip-3f112f25' '/ecloud/v2/ip-addresses/{ipAddressId}': get: tags: - 'IP Addresses' parameters: - name: ipAddressId in: path required: true schema: type: string example: ip-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true meta: type: object patch: tags: - 'IP Addresses' parameters: - name: ipAddressId in: path required: true schema: type: string example: ip-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true - type: object properties: name: required: false ip_address: readOnly: true type: readOnly: true network_id: type: string readOnly: true example: net-abc123 required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ip-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/ip-addresses/ip-3f112f25' /ecloud/v2/load-balancers: get: tags: - 'Load Balancers' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/load-balancers?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/load-balancers?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/load-balancers?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/load-balancers?page=2' post: tags: - 'Load Balancers' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: lb-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/load-balancers/lb-6ui8gt89' '/ecloud/v2/load-balancers/{loadBalancerId}': get: tags: - 'Load Balancers' parameters: - name: id in: path required: true schema: type: string example: lb-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' meta: type: object delete: tags: - 'Load Balancers' parameters: - name: id in: path required: true schema: type: string example: lb-3f112f25 responses: '202': description: Accepted patch: tags: - 'Load Balancers' parameters: - name: id in: path required: true schema: type: string example: lb-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' - type: object properties: vpc_id: readOnly: true required: false availability_zone_id: readOnly: true required: false load_balancer_spec_id: readOnly: true required: false network_id: readOnly: true required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: lb-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/load-balancers/lb-6ui8gt89' /ecloud/v2/load-balancer-specs: get: tags: - 'Load Balancer Specification' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: lbs-0c03049b name: type: string readOnly: false example: small description: type: string readOnly: false example: 'Example description' description: 'Load Balancer Specifications' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=2' '/ecloud/v2/load-balancer-specs/{loadBalancerSpecificationId}': get: tags: - 'Load Balancer Specification' parameters: - name: lbsId in: path required: true schema: type: string example: lbs-0c03049b responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: lbs-0c03049b name: type: string readOnly: false example: small description: type: string readOnly: false example: 'Example description' description: 'Load Balancer Specifications' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/load-balancer-specs?page=2' /ecloud/v2/monitoring-gateways: get: tags: - 'Monitoring Gateways' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: mgw-3f112f25 name: type: string example: 'Monitoring Gateway' required: false vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router the monitoring gateway is assigned to' readOnly: true example: rtr-2b66bb79 required: false specification_id: type: string description: 'Specification id assigned to monitoring gateway' readOnly: true example: mgws-5da6vc35 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Monitoring Gateways' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways?page=2' post: tags: - 'Monitoring Gateways' requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: mgw-3f112f25 name: type: string example: 'Monitoring Gateway' required: false vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router the monitoring gateway is assigned to' readOnly: true example: rtr-2b66bb79 required: false specification_id: type: string description: 'Specification id assigned to monitoring gateway' readOnly: true example: mgws-5da6vc35 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Monitoring Gateways' - type: object properties: name: readOnly: false required: true specification_id: readOnly: false required: true router_id: readOnly: false required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: mgw-3f112f25 task_id: type: string example: task-abc123xy meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways/mgw-3f112f25' '/ecloud/v2/monitoring-gateways/{monitoringGatewayId}': get: tags: - 'Monitoring Gateways' parameters: - name: id in: path required: true schema: type: string example: mgw-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: mgw-3f112f25 name: type: string example: 'Monitoring Gateway' required: false vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router the monitoring gateway is assigned to' readOnly: true example: rtr-2b66bb79 required: false specification_id: type: string description: 'Specification id assigned to monitoring gateway' readOnly: true example: mgws-5da6vc35 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Monitoring Gateways' meta: type: object delete: tags: - 'Monitoring Gateways' parameters: - name: id in: path required: true schema: type: string example: mgw-3f112f25 responses: '202': description: Accepted patch: tags: - 'Monitoring Gateways' parameters: - name: id in: path required: true schema: type: string example: mgw-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: mgw-3f112f25 name: type: string example: 'Monitoring Gateway' required: false vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router the monitoring gateway is assigned to' readOnly: true example: rtr-2b66bb79 required: false specification_id: type: string description: 'Specification id assigned to monitoring gateway' readOnly: true example: mgws-5da6vc35 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Monitoring Gateways' - type: object properties: name: readOnly: false required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: mgw-3f112f25 task_id: type: string example: task-abc123xy meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateways/mgw-3f112f25' /ecloud/v2/monitoring-gateway-specifications: get: tags: - 'Monitoring Gateway Specifications' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string example: mgws-2b66bb79 name: type: string example: 'Monitoring Gateway Specification Name' description: type: string example: 'Description of the Monitoring Gateway Specification' order: type: integer description: 'Order in which the Monitoring Gateway Specification is displayed and returned by the API' example: 1 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'Monitoring Gateway Specification' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateway-specifications?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateway-specifications?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateway-specifications?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/monitoring-gateway-specifications?page=2' '/ecloud/v2/monitoring-gateway-specifications/{monitoringGatewaySpecificationId}': get: tags: - 'Monitoring Gateway Specifications' parameters: - name: monitoring_gateway_specification_id in: path description: 'The ID of the Monitoring Gateway Specification' required: true schema: type: string example: mgws-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: properties: id: type: string example: mgws-2b66bb79 name: type: string example: 'Monitoring Gateway Specification Name' description: type: string example: 'Description of the Monitoring Gateway Specification' order: type: integer description: 'Order in which the Monitoring Gateway Specification is displayed and returned by the API' example: 1 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'Monitoring Gateway Specification' meta: type: object /ecloud/v2/nat-overload-rules: get: tags: - 'NAT Overload Rules' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nor-2b66bb79 name: type: string readOnly: false example: 'NAT Overload Rule 1' required: false network_id: type: string description: 'ID of the network to assign to the load balancer' readOnly: false example: net-4c63cf58 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true action: type: string description: 'One of ALLOW or DENY' readOnly: false example: ALLOW required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Hosts meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules?page=2' post: tags: - 'NAT Overload Rules' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: nor-2b66bb79 name: type: string readOnly: false example: 'NAT Overload Rule 1' required: false network_id: type: string description: 'ID of the network to assign to the load balancer' readOnly: false example: net-4c63cf58 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true action: type: string description: 'One of ALLOW or DENY' readOnly: false example: ALLOW required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Hosts required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nor-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules/nor-3f112f25' '/ecloud/v2/nat-overload-rules/{natOverloadRuleId}': get: tags: - 'NAT Overload Rules' parameters: - name: id in: path required: true schema: type: string example: nor-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: nor-2b66bb79 name: type: string readOnly: false example: 'NAT Overload Rule 1' required: false network_id: type: string description: 'ID of the network to assign to the load balancer' readOnly: false example: net-4c63cf58 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true action: type: string description: 'One of ALLOW or DENY' readOnly: false example: ALLOW required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Hosts meta: type: object delete: tags: - 'NAT Overload Rules' parameters: - name: id in: path required: true schema: type: string example: nor-3f112f25 responses: '202': description: Accepted patch: tags: - 'NAT Overload Rules' parameters: - name: id in: path required: true schema: type: string example: nor-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: nor-2b66bb79 name: type: string readOnly: false example: 'NAT Overload Rule 1' required: false network_id: type: string description: 'ID of the network to assign to the load balancer' readOnly: false example: net-4c63cf58 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true action: type: string description: 'One of ALLOW or DENY' readOnly: false example: ALLOW required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Hosts - type: object properties: network_id: readOnly: true floating_ip_id: readOnly: true action: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nor-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/nat-overload-rules/nor-3f112f25' /ecloud/v2/network-policies: get: tags: - 'Network Policies' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: np-abc123xyz name: type: string example: 'Default Network Policy' network_id: type: string example: net-912345 required: true vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true catchall_rule_action: type: string description: 'Action to apply to the catchall rule, allowed options are ALLOW,DROP,REJECT. Default action is REJECT.' writeOnly: true example: ALLOW required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Policies' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/network-policies?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/network-policies?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/network-policies?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/network-policies?page=2' post: tags: - 'Network Policies' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: np-abc123xyz name: type: string example: 'Default Network Policy' network_id: type: string example: net-912345 required: true vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true catchall_rule_action: type: string description: 'Action to apply to the catchall rule, allowed options are ALLOW,DROP,REJECT. Default action is REJECT.' writeOnly: true example: ALLOW required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Policies' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: np-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-policies/np-abc123xyz' '/ecloud/v2/network-policies/{networkPolicyId}': get: tags: - 'Network Policies' parameters: - name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: np-abc123xyz name: type: string example: 'Default Network Policy' network_id: type: string example: net-912345 required: true vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true catchall_rule_action: type: string description: 'Action to apply to the catchall rule, allowed options are ALLOW,DROP,REJECT. Default action is REJECT.' writeOnly: true example: ALLOW required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Policies' meta: type: object delete: tags: - 'Network Policies' parameters: - name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'Network Policies' parameters: - name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: np-abc123xyz name: type: string example: 'Default Network Policy' network_id: type: string example: net-912345 required: true vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true catchall_rule_action: type: string description: 'Action to apply to the catchall rule, allowed options are ALLOW,DROP,REJECT. Default action is REJECT.' writeOnly: true example: ALLOW required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Policies' - type: object properties: name: required: false network_id: readOnly: true catchall_rule_action: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: np-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-policies/np-abc123xyz' '/ecloud/v2/network-policies/{networkPolicyId}/network-rules': get: tags: - 'Network Policies' parameters: - name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/network-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/network-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/network-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/network-rules?page=2' '/ecloud/v2/network-policies/{networkPolicyId}/tasks': get: tags: - 'Network Policies' parameters: - name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/network-policies/{networkPolicyId}/tasks?page=2' /ecloud/v2/network-rule-ports: get: tags: - 'Network Rule Ports' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false network_rule_id: type: string readOnly: false example: nr-4c63cf58 required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule Ports' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports?page=2' post: tags: - 'Network Rule Ports' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: nrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false network_rule_id: type: string readOnly: false example: nr-4c63cf58 required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule Ports' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nrp-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports/nrp-3f112f25' '/ecloud/v2/network-rule-ports/{networkRulePortId}': get: tags: - 'Network Rule Ports' parameters: - name: networkRulePortId in: path required: true schema: type: string example: nrp-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: nrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false network_rule_id: type: string readOnly: false example: nr-4c63cf58 required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule Ports' meta: type: object delete: tags: - 'Network Rule Ports' parameters: - name: networkRulePortId in: path required: true schema: type: string example: nrp-3f112f25 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'Network Rule Ports' parameters: - name: networkRulePortId in: path required: true schema: type: string example: nrp-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: nrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false network_rule_id: type: string readOnly: false example: nr-4c63cf58 required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule Ports' - type: object properties: network_rule_id: type: string readOnly: true example: nr-4c63cf58 required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nrp-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports/nrp-3f112f25' /ecloud/v2/network-rules: get: tags: - 'Network Rule' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/network-rules?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/network-rules?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/network-rules?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/network-rules?page=2' post: tags: - 'Network Rule' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nr-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rules/nr-abc123xyz' '/ecloud/v2/network-rules/{networkRuleId}': get: tags: - 'Network Rule' parameters: - name: NetworkRuleId in: path required: true schema: type: string example: nr-abc123xyz responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' meta: type: object delete: tags: - 'Network Rule' parameters: - name: NetworkRuleId in: path required: true schema: type: string example: nr-abc123xyz responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'Network Rule' parameters: - name: NetworkRuleId in: path required: true schema: type: string example: nr-abc123xyz requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' - type: object properties: name: required: false network_policy_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nr-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rules/nr-abc123xyz' /ecloud/v2/networks: get: tags: - Networks parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/networks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/networks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/networks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/networks?page=2' post: tags: - Networks requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: net-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/networks/net-6ui8gt89' '/ecloud/v2/networks/{networkId}': get: tags: - Networks parameters: - name: networkId in: path required: true schema: type: string example: net-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks meta: type: object delete: tags: - Networks parameters: - name: networkId in: path required: true schema: type: string example: net-2b66bb79 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - Networks parameters: - name: networkId in: path required: true schema: type: string example: net-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks - type: object properties: name: required: false router_id: readOnly: true required: false subnet: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: net-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/networks/net-6ui8gt89' '/ecloud/v2/networks/{networkId}/nics': get: tags: - Networks parameters: - name: networkId in: path required: true schema: type: string example: net-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nic-2b66bb79 name: type: string example: 'Nic 1' required: false mac_address: type: string readOnly: false example: '3D:F2:C9:A6:B3:4F' required: true instance_id: type: string readOnly: false example: i-2b66bb79 required: true network_id: type: string readOnly: false example: net-2b66bb79 required: true ip_address: type: string description: 'DHCP IP Address' readOnly: true example: 10.0.0.5 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Nics meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/nics?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/nics?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/nics?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/nics?page=2' '/ecloud/v2/networks/{networkId}/tasks': get: tags: - Networks parameters: - name: networkId in: path required: true schema: type: string example: net-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/networks/{networkId}/tasks?page=2' /ecloud/v2/nics: get: tags: - Nics parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: nic-2b66bb79 name: type: string example: 'Nic 1' required: false mac_address: type: string readOnly: false example: '3D:F2:C9:A6:B3:4F' required: true instance_id: type: string readOnly: false example: i-2b66bb79 required: true network_id: type: string readOnly: false example: net-2b66bb79 required: true ip_address: type: string description: 'DHCP IP Address' readOnly: true example: 10.0.0.5 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Nics meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/nics?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/nics?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/nics?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/nics?page=2' '/ecloud/v2/nics/{nicId}': get: tags: - Nics parameters: - name: nicId in: path required: true schema: type: string example: nic-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: nic-2b66bb79 name: type: string example: 'Nic 1' required: false mac_address: type: string readOnly: false example: '3D:F2:C9:A6:B3:4F' required: true instance_id: type: string readOnly: false example: i-2b66bb79 required: true network_id: type: string readOnly: false example: net-2b66bb79 required: true ip_address: type: string description: 'DHCP IP Address' readOnly: true example: 10.0.0.5 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Nics meta: type: object '/ecloud/v2/nics/{nicId}/ip-addresses': get: tags: - Nics description: 'List the IP addressses associated with a NIC' parameters: - name: nicId in: path required: true schema: type: string example: nic-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/ip-addresses?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/ip-addresses?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/ip-addresses?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/ip-addresses?page=2' post: tags: - Nics description: 'Bind a cluster IP address to a NIC' requestBody: content: application/json: schema: type: object properties: ip_address_id: type: string example: ip-2b66bb79 required: true description: 'ID of the IP address to bind' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' '/ecloud/v2/nics/{nicId}/ip-addresses/{ipAddressId}': delete: tags: - Nics parameters: - name: nicId in: path required: true schema: type: string example: nic-2b66bb79 - name: ipAddressId in: path required: true schema: type: string example: ip-3f112f25 responses: '202': description: Accepted '/ecloud/v2/nics/{nicId}/tasks': get: tags: - Nics parameters: - name: nicId in: path required: true schema: type: string example: nic-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/nics/{nicId}/tasks?page=2' /ecloud/v2/regions: get: tags: - Regions parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: reg-2b66bb79 name: type: string example: 'United Kingdom' description: Regions meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/regions?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/regions?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/regions?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/regions?page=2' '/ecloud/v2/regions/{regionId}': get: tags: - Regions parameters: - name: regionId in: path required: true schema: type: string example: reg-cd226940 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: reg-2b66bb79 name: type: string example: 'United Kingdom' description: Regions meta: type: object '/ecloud/v2/regions/{regionId}/prices': get: tags: - Regions parameters: - name: regionId in: path required: true schema: type: string example: reg-cd226940 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: availability_zone_id: type: string example: az-2b66bb79 name: type: string example: ram description: type: string description: 'Description of the product' example: '1GB RAM (upto 24GB)' category: type: string description: 'Product category, one of compute / storage / networking / license / support' example: compute price: description: 'Price of this product in the stated availability zone.' example: '0.958904' type: null rate: type: string description: 'The rate / frequency that applies to the specified price.' example: hour meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/availability-zones/{AvailabilityZoneId}/prices?page=2' /ecloud/v2/resource-tiers: get: tags: - 'Resource Tiers' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: rt-2b66bb79 name: type: string readOnly: false example: 'Resource Tier 1' required: false description: type: string readOnly: false example: 'Resource Tier 1 description' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true cpu: type: object properties: min: type: integer description: 'Minimum total VCPU cores allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum total VCPU cores allowed for instance on this tier' example: 10 readOnly: true cpu_sockets: type: object properties: min: type: integer description: 'Minimum VCPU sockets allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum VCPU sockets allowed for instance on this tier' example: 10 readOnly: true ram: type: object properties: min: type: integer description: 'Minimum RAM MiB allowed for instance on this tier' example: 1024 max: type: integer description: 'Maximum RAM MiB allowed for instance on this tier' example: 131072 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Resource Tiers' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/resource-tiers?page=2' '/ecloud/v2/resource-tiers/{resourceTierId}': get: tags: - 'Resource Tiers' parameters: - name: id in: path required: true schema: type: string example: rt-aaaaaaaa responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: rt-2b66bb79 name: type: string readOnly: false example: 'Resource Tier 1' required: false description: type: string readOnly: false example: 'Resource Tier 1 description' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true cpu: type: object properties: min: type: integer description: 'Minimum total VCPU cores allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum total VCPU cores allowed for instance on this tier' example: 10 readOnly: true cpu_sockets: type: object properties: min: type: integer description: 'Minimum VCPU sockets allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum VCPU sockets allowed for instance on this tier' example: 10 readOnly: true ram: type: object properties: min: type: integer description: 'Minimum RAM MiB allowed for instance on this tier' example: 1024 max: type: integer description: 'Maximum RAM MiB allowed for instance on this tier' example: 131072 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Resource Tiers' meta: type: object /ecloud/v2/routers: get: tags: - Routers parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: rtr-2b66bb79 name: type: string example: rtr-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true router_throughput_id: type: string description: 'ID of the router throughput profile to assign to the router' example: rtp-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/routers?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/routers?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/routers?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/routers?page=2' post: tags: - Routers requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: rtr-2b66bb79 name: type: string example: rtr-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true router_throughput_id: type: string description: 'ID of the router throughput profile to assign to the router' example: rtp-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: rtr-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/routers/rtr-6ui8gt89' '/ecloud/v2/routers/{routerId}': get: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: rtr-2b66bb79 name: type: string example: rtr-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true router_throughput_id: type: string description: 'ID of the router throughput profile to assign to the router' example: rtp-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: type: object delete: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: rtr-2b66bb79 name: type: string example: rtr-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true router_throughput_id: type: string description: 'ID of the router throughput profile to assign to the router' example: rtp-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers - type: object properties: name: required: false vpc_id: readOnly: true required: false availability_zone_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: rtr-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/routers/rtr-6ui8gt89' '/ecloud/v2/routers/{routerId}/configure-default-policies': post: tags: - Routers description: 'Configure the default firewall policies for the router' parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '202': description: Accepted '/ecloud/v2/routers/{routerId}/firewall-policies': get: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/firewall-policies?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/firewall-policies?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/firewall-policies?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/firewall-policies?page=2' '/ecloud/v2/routers/{routerId}/networks': get: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/networks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/networks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/networks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/networks?page=2' '/ecloud/v2/routers/{routerId}/tasks': get: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/tasks?page=2' '/ecloud/v2/routers/{routerId}/vpns': get: tags: - Routers parameters: - name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/vpns?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/vpns?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/vpns?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/routers/{routerId}/vpns?page=2' /ecloud/v2/router-throughputs: get: tags: - 'Router Throughput' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: rtp-2b66bb79 availability_zone_id: type: string description: 'The Availability Zone that this router throughput option is available on' example: az-2b66bb79 required: true name: type: string example: 10Gb required: false committed_bandwidth: type: integer description: 'Bandwidth in Mbps' example: 10240 required: true description: 'Router Throughput' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/router-throughputs?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/router-throughputs?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/router-throughputs?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/router-throughputs?page=2' '/ecloud/v2/router-throughputs/{routerThroughputId}': get: tags: - 'Router Throughput' parameters: - name: routerThroughputId in: path required: true schema: type: string example: rtp-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: rtp-2b66bb79 availability_zone_id: type: string description: 'The Availability Zone that this router throughput option is available on' example: az-2b66bb79 required: true name: type: string example: 10Gb required: false committed_bandwidth: type: integer description: 'Bandwidth in Mbps' example: 10240 required: true description: 'Router Throughput' meta: type: object /ecloud/v2/scripts: get: tags: - Scripts parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: scr-2b66bb79 name: type: string readOnly: false example: 'Script 1' required: false software_id: type: string description: 'The ID of the associated software resource' readOnly: false example: soft-4c63cf58 required: true sequence: type: string description: 'Execution order' readOnly: false example: 1 required: true script: type: string description: 'The script to be executed' readOnly: false required: true description: Scripts meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/scripts?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/scripts?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/scripts?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/scripts?page=2' '/ecloud/v2/scripts/{scriptId}': get: tags: - Scripts parameters: - name: id in: path required: true schema: type: string example: scr-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: scr-2b66bb79 name: type: string readOnly: false example: 'Script 1' required: false software_id: type: string description: 'The ID of the associated software resource' readOnly: false example: soft-4c63cf58 required: true sequence: type: string description: 'Execution order' readOnly: false example: 1 required: true script: type: string description: 'The script to be executed' readOnly: false required: true description: Scripts meta: type: object /ecloud/v2/software: get: tags: - Software parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: soft-2b66bb79 name: type: string readOnly: false example: Mcafee required: false platform: type: string readOnly: false example: Linux required: true description: Software meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/software?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/software?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/software?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/software?page=2' '/ecloud/v2/software/{softwareId}': get: tags: - Software parameters: - name: id in: path required: true schema: type: string example: soft-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: soft-2b66bb79 name: type: string readOnly: false example: Mcafee required: false platform: type: string readOnly: false example: Linux required: true description: Software meta: type: object '/ecloud/v2/software/{softwareId}/images': get: tags: - Software parameters: - name: id in: path required: true schema: type: string example: soft-3f112f25 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'CentOS 7' logo_uri: type: string readOnly: true example: 'https://example.com/image.png' documentation_uri: type: string readOnly: true example: 'https://example.com/docs' vpc_id: type: string description: 'ID of the VPC that the image is assigned to for private images' readOnly: true example: vpc-abc123 description: type: string readOnly: true example: 'Linux operating system' visibility: type: string readOnly: true example: public image_size: type: integer readOnly: true example: 60 platform: type: string readOnly: true example: Linux sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true description: Images meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/images?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/images?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/images?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/images?page=2' '/ecloud/v2/software/{softwareId}/scripts': get: tags: - Software parameters: - name: id in: path required: true schema: type: string example: soft-3f112f25 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: scr-2b66bb79 name: type: string readOnly: false example: 'Script 1' required: false software_id: type: string description: 'The ID of the associated software resource' readOnly: false example: soft-4c63cf58 required: true sequence: type: string description: 'Execution order' readOnly: false example: 1 required: true script: type: string description: 'The script to be executed' readOnly: false required: true description: Scripts meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/scripts?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/scripts?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/scripts?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/software/{softwareId}/scripts?page=2' /ecloud/v2/ssh-key-pairs: get: tags: - 'SSH Key Pairs' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: ssh-2b66bb79 name: type: string example: mykey public_key: type: string example: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDFnKEoztA5+jy3u/uQ9eLhFbMKuCMvZFkflRPtYu0zcq1pkjGZZ5BrOJgLu36eGvVIqZBgtaFefmCVVKZyqXfQ8v/uXb/Liv5HqmFquLq8F/80GJ7djYqL0ZzHxkAdGEWikeN3kbcZOHG2MvFpTlg7IVuh7lujRMYklJbG3P9azQ==' created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: SSHKeyPair post: tags: - 'SSH Key Pairs' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: ssh-2b66bb79 name: type: string example: mykey public_key: type: string example: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDFnKEoztA5+jy3u/uQ9eLhFbMKuCMvZFkflRPtYu0zcq1pkjGZZ5BrOJgLu36eGvVIqZBgtaFefmCVVKZyqXfQ8v/uXb/Liv5HqmFquLq8F/80GJ7djYqL0ZzHxkAdGEWikeN3kbcZOHG2MvFpTlg7IVuh7lujRMYklJbG3P9azQ==' created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: SSHKeyPair required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ssh-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/ssh-key-pairs/ssh-6ui8gt89' '/ecloud/v2/ssh-key-pairs/{keypairId}': get: tags: - 'SSH Key Pairs' parameters: - name: keypairId in: path required: true schema: type: string example: ssh-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: ssh-2b66bb79 name: type: string example: mykey public_key: type: string example: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDFnKEoztA5+jy3u/uQ9eLhFbMKuCMvZFkflRPtYu0zcq1pkjGZZ5BrOJgLu36eGvVIqZBgtaFefmCVVKZyqXfQ8v/uXb/Liv5HqmFquLq8F/80GJ7djYqL0ZzHxkAdGEWikeN3kbcZOHG2MvFpTlg7IVuh7lujRMYklJbG3P9azQ==' created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: SSHKeyPair meta: type: object delete: tags: - 'SSH Key Pairs' parameters: - name: keypairId in: path required: true schema: type: string example: ssh-2b66bb79 responses: '200': description: success patch: tags: - 'SSH Key Pairs' parameters: - name: keypairId in: path required: true schema: type: string example: ssh-2b66bb79 requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: ssh-2b66bb79 name: type: string example: mykey public_key: type: string example: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDFnKEoztA5+jy3u/uQ9eLhFbMKuCMvZFkflRPtYu0zcq1pkjGZZ5BrOJgLu36eGvVIqZBgtaFefmCVVKZyqXfQ8v/uXb/Liv5HqmFquLq8F/80GJ7djYqL0ZzHxkAdGEWikeN3kbcZOHG2MvFpTlg7IVuh7lujRMYklJbG3P9azQ==' created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: SSHKeyPair required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: ssh-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/ssh-key-pairs/ssh-6ui8gt89' /ecloud/v2/tags: get: tags: - Tags parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: tag-9fcb2a3c name: type: string example: 'My Tag' scope: type: string nullable: true example: global created_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' description: Tag meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/tags?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/tags?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/tags?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/tags?page=2' post: tags: - Tags requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: tag-9fcb2a3c name: type: string example: 'My Tag' scope: type: string nullable: true example: global created_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' description: Tag - type: object required: true responses: '201': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: tag-3f112f25 task_id: type: string example: task-abc123xy meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tags/tag-3f112f25' '/ecloud/v2/tags/{tagId}': get: tags: - Tags parameters: - name: id in: path required: true schema: type: string example: tag-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: tag-9fcb2a3c name: type: string example: 'My Tag' scope: type: string nullable: true example: global created_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' description: Tag meta: type: object delete: tags: - Tags parameters: - name: id in: path required: true schema: type: string example: tag-3f112f25 responses: '204': description: Success patch: tags: - Tags parameters: - name: id in: path required: true schema: type: string example: tag-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: tag-9fcb2a3c name: type: string example: 'My Tag' scope: type: string nullable: true example: global created_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' description: Tag - type: object properties: name: readOnly: false required: true responses: '201': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: tag-3f112f25 task_id: type: string example: task-abc123xy meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tags/tag-3f112f25' /ecloud/v2/tasks: get: tags: - Tasks parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/tasks?page=2' '/ecloud/v2/tasks/{taskId}': get: tags: - Tasks parameters: - name: taskId in: path required: true schema: type: string example: task-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: type: object /ecloud/v2/vips: get: tags: - Vips parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vip-2b66bb79 name: type: string readOnly: false example: 'VIP 1' required: false load_balancer_id: type: string description: 'ID of the load balancer that the VIP is associated with.' readOnly: false example: lb-4c63cf58 required: true ip_address_id: type: string description: 'ID of the IP address assigned to the resource.' readOnly: true example: ip-4c63cf58 required: false config_id: type: integer description: 'Load balancer service VIP identification' readOnly: true example: 12345 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: VIPs meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vips?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vips?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vips?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vips?page=2' post: tags: - Vips requestBody: content: application/json: schema: allOf: - properties: id: type: string readOnly: true example: vip-2b66bb79 name: type: string readOnly: false example: 'VIP 1' required: false load_balancer_id: type: string description: 'ID of the load balancer that the VIP is associated with.' readOnly: false example: lb-4c63cf58 required: true ip_address_id: type: string description: 'ID of the IP address assigned to the resource.' readOnly: true example: ip-4c63cf58 required: false config_id: type: integer description: 'Load balancer service VIP identification' readOnly: true example: 12345 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: VIPs - type: object properties: allocate_floating_ip: type: boolean description: 'Whether to allocate a floating IP to the VIP, defaults to false.' required: false required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vip-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vips/vip-3f112f25' '/ecloud/v2/vips/{vipId}': get: tags: - Vips parameters: - name: id in: path required: true schema: type: string example: vip-3f112f25 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vip-2b66bb79 name: type: string readOnly: false example: 'VIP 1' required: false load_balancer_id: type: string description: 'ID of the load balancer that the VIP is associated with.' readOnly: false example: lb-4c63cf58 required: true ip_address_id: type: string description: 'ID of the IP address assigned to the resource.' readOnly: true example: ip-4c63cf58 required: false config_id: type: integer description: 'Load balancer service VIP identification' readOnly: true example: 12345 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: VIPs meta: type: object delete: tags: - Vips parameters: - name: id in: path required: true schema: type: string example: vip-3f112f25 responses: '202': description: Accepted patch: tags: - Vips parameters: - name: id in: path required: true schema: type: string example: vip-3f112f25 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vip-2b66bb79 name: type: string readOnly: false example: 'VIP 1' required: false load_balancer_id: type: string description: 'ID of the load balancer that the VIP is associated with.' readOnly: false example: lb-4c63cf58 required: true ip_address_id: type: string description: 'ID of the IP address assigned to the resource.' readOnly: true example: ip-4c63cf58 required: false config_id: type: integer description: 'Load balancer service VIP identification' readOnly: true example: 12345 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: VIPs - type: object properties: network_id: readOnly: true load_balancer_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vip-3f112f25 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vips/vip-3f112f25' /ecloud/v2/volumes: get: tags: - Volumes parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/volumes?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/volumes?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/volumes?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/volumes?page=2' post: tags: - Volumes requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vol-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/volumes/vol-6ui8gt89' '/ecloud/v2/volumes/{volumeId}': get: tags: - Volumes parameters: - name: volumeId in: path required: true schema: type: string example: vol-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: type: object delete: tags: - Volumes parameters: - name: volumeId in: path required: true schema: type: string example: vol-2b66bb79 responses: '202': description: Accepted patch: tags: - Volumes parameters: - name: volumeId in: path required: true schema: type: string example: vol-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers - type: object properties: availability_zone_id: readOnly: true vpc_id: readOnly: true required: false capacity: required: false type: readOnly: true is_shared: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vol-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/volumes/vol-6ui8gt89' '/ecloud/v2/volumes/{volumeId}/instances': get: tags: - Volumes parameters: - name: volumeId in: path required: true schema: type: string example: vol-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances meta: type: object '/ecloud/v2/volumes/{volumeId}/tasks': get: tags: - Volumes parameters: - name: volumeId in: path required: true schema: type: string example: vol-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/volumes/{volumeId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/volumes/{volumeId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/volumes/{volumeId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/volumes/{volumeId}/tasks?page=2' /ecloud/v2/volume-groups: get: tags: - 'Volume Groups' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: volgroup-2b66bb79 name: type: string example: volgroup-2b66bb79 required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true usage: type: object properties: volumes: type: integer description: 'The number of volumes associated with this volume group.' example: 10 readOnly: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/volume-groups?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/volume-groups?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/volume-groups?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/volume-groups?page=2' post: tags: - 'Volume Groups' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: volgroup-2b66bb79 name: type: string example: volgroup-2b66bb79 required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true usage: type: object properties: volumes: type: integer description: 'The number of volumes associated with this volume group.' example: 10 readOnly: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-6ui8gt89' '/ecloud/v2/volume-groups/{volumeGroupId}': get: tags: - 'Volume Groups' parameters: - name: volumeGroupId in: path required: true schema: type: string example: volgroup-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: volgroup-2b66bb79 name: type: string example: volgroup-2b66bb79 required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true usage: type: object properties: volumes: type: integer description: 'The number of volumes associated with this volume group.' example: 10 readOnly: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: type: object delete: tags: - 'Volume Groups' parameters: - name: volumeGroupId in: path required: true schema: type: string example: volgroup-2b66bb79 responses: '202': description: Accepted patch: tags: - 'Volume Groups' parameters: - name: volumeGroupId in: path required: true schema: type: string example: volgroup-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: volgroup-2b66bb79 name: type: string example: volgroup-2b66bb79 required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true usage: type: object properties: volumes: type: integer description: 'The number of volumes associated with this volume group.' example: 10 readOnly: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns - type: object properties: availability_zone_id: readOnly: true vpc_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-6ui8gt89' '/ecloud/v2/volume-groups/{volumeGroupId}/volumes': get: tags: - 'Volume Groups' parameters: - name: volumeGroupId in: path required: true schema: type: string example: volgroup-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-2b66bb79/volumes?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-2b66bb79/volumes?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-2b66bb79/volumes?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-2b66bb79/volumes?page=2' /ecloud/v2/vpcs: get: tags: - 'Virtual Private Clouds' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpcs?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpcs?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpcs?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpcs?page=2' post: tags: - 'Virtual Private Clouds' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpc-2b66bb79 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpcs/vpc-2b66bb79' '/ecloud/v2/vpcs/{vpcId}': get: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' meta: type: object delete: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' - type: object properties: advanced_networking: readOnly: true region_id: type: string readOnly: true example: reg-a63dd78c required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpc-2b66bb79 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpcs/vpc-2b66bb79' '/ecloud/v2/vpcs/{vpcId}/deploy-defaults': post: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' - type: object properties: name: readOnly: true region_id: readOnly: true advanced_networking: readOnly: true availability_zone_id: readOnly: false example: az-abc123xyz required: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpc-2b66bb79 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpcs/vpc-2b66bb79' '/ecloud/v2/vpcs/{vpcId}/instances': get: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/instances?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/instances?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/instances?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/instances?page=2' '/ecloud/v2/vpcs/{vpcId}/tasks': get: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/tasks?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/tasks?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/tasks?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/tasks?page=2' '/ecloud/v2/vpcs/{vpcId}/volumes': get: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/volumes?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/volumes?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/volumes?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/volumes?page=2' '/ecloud/v2/vpcs/{vpcId}/load-balancers': get: tags: - 'Virtual Private Clouds' parameters: - name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/load-balancers?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/load-balancers?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/load-balancers?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpcs/{vpcId}/load-balancers?page=2' /ecloud/v2/vpn-endpoints: get: tags: - 'Vpn Endpoints' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpne-2b66bb79 name: type: string example: vpne-2b66bb79 required: false vpn_service_id: type: string readOnly: false example: vpn-2b66bb79 required: true floating_ip_id: type: string readOnly: false example: fip-2b66bb79 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints?page=2' post: tags: - 'Vpn Endpoints' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vpne-2b66bb79 name: type: string example: vpne-2b66bb79 required: false vpn_service_id: type: string readOnly: false example: vpn-2b66bb79 required: true floating_ip_id: type: string readOnly: false example: fip-2b66bb79 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints/vpne-6ui8gt89' '/ecloud/v2/vpn-endpoints/{vpnEndpointId}': get: tags: - 'Vpn Endpoints' parameters: - name: vpnId in: path required: true schema: type: string example: vpne-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vpne-2b66bb79 name: type: string example: vpne-2b66bb79 required: false vpn_service_id: type: string readOnly: false example: vpn-2b66bb79 required: true floating_ip_id: type: string readOnly: false example: fip-2b66bb79 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: type: object delete: tags: - 'Vpn Endpoints' parameters: - name: vpnId in: path required: true schema: type: string example: vpne-2b66bb79 responses: '202': description: Accepted patch: tags: - 'Vpn Endpoints' parameters: - name: vpnId in: path required: true schema: type: string example: vpne-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vpne-2b66bb79 name: type: string example: vpne-2b66bb79 required: false vpn_service_id: type: string readOnly: false example: vpn-2b66bb79 required: true floating_ip_id: type: string readOnly: false example: fip-2b66bb79 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns - type: object properties: vpn_service_id: readOnly: true floating_ip_id: readOnly: true required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints/vpne-6ui8gt89' /ecloud/v2/vpn-gateways: get: tags: - 'VPN Gateways' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vgw-00661c58 name: type: string example: 'VPN Gateway Name' availability_zone_id: type: string description: 'ID of the Availability Zone that the VPN Gateway will use' readOnly: true example: az-2b66bb79 router_id: type: string description: 'ID of the Router that the VPN Gateway will use' example: rtr-2b66bb79 specification_id: type: string description: 'ID of the VPN Gateway Specification that the VPN Gateway will use' example: vgws-2b66bb79 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways?page=2' post: tags: - 'VPN Gateways' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vgw-00661c58 name: type: string example: 'VPN Gateway Name' availability_zone_id: type: string description: 'ID of the Availability Zone that the VPN Gateway will use' readOnly: true example: az-2b66bb79 router_id: type: string description: 'ID of the Router that the VPN Gateway will use' example: rtr-2b66bb79 specification_id: type: string description: 'ID of the VPN Gateway Specification that the VPN Gateway will use' example: vgws-2b66bb79 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vgw-00661c58 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways/vgw-5cfb61e4' '/ecloud/v2/vpn-gateways/{VpnGatewayId}': get: tags: - 'VPN Gateways' parameters: - name: VpnGatewayId in: path required: true schema: type: string example: vgw-00661c58 responses: '200': description: Success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vgw-00661c58 name: type: string example: 'VPN Gateway Name' availability_zone_id: type: string description: 'ID of the Availability Zone that the VPN Gateway will use' readOnly: true example: az-2b66bb79 router_id: type: string description: 'ID of the Router that the VPN Gateway will use' example: rtr-2b66bb79 specification_id: type: string description: 'ID of the VPN Gateway Specification that the VPN Gateway will use' example: vgws-2b66bb79 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway' meta: type: object delete: tags: - 'VPN Gateways' parameters: - name: VpnGatewayId in: path required: true schema: type: string example: vgw-00661c58 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'VPN Gateways' parameters: - name: VpnGatewayId in: path required: true schema: type: string example: vgw-00661c58 requestBody: content: application/json: schema: properties: name: type: string example: 'VPN Gateway Name' description: 'VPN Gateway' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vgw-00661c58 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-gateways/vgw-5cfb61e4' /ecloud/v2/vpn-gateway-users/: get: tags: - 'VPN Gateway Users' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vgwu-00661c58 name: type: string example: 'VPN Gateway User Name' vpn_gateway_id: type: string description: 'ID of the VPN Gateway that the User will be on' example: vgw-2b66bb79 username: type: string description: 'The username of the VPN Gateway User' writeOnly: true example: vpn_user password: type: string description: 'The password of the VPN Gateway User' writeOnly: true example: password123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway User' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users?page=2' post: tags: - 'VPN Gateway Users' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vgwu-00661c58 name: type: string example: 'VPN Gateway User Name' vpn_gateway_id: type: string description: 'ID of the VPN Gateway that the User will be on' example: vgw-2b66bb79 username: type: string description: 'The username of the VPN Gateway User' writeOnly: true example: vpn_user password: type: string description: 'The password of the VPN Gateway User' writeOnly: true example: password123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway User' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vgwu-00661c58 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users/vgwu-5cfb61e4' '/ecloud/v2/vpn-gateway-users/{VpnGatewayUserId}': get: tags: - 'VPN Gateway Users' parameters: - name: VpnGatewayUserId in: path required: true schema: type: string example: vgwu-00661c58 responses: '200': description: Success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vgwu-00661c58 name: type: string example: 'VPN Gateway User Name' vpn_gateway_id: type: string description: 'ID of the VPN Gateway that the User will be on' example: vgw-2b66bb79 username: type: string description: 'The username of the VPN Gateway User' writeOnly: true example: vpn_user password: type: string description: 'The password of the VPN Gateway User' writeOnly: true example: password123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway User' meta: type: object delete: tags: - 'VPN Gateway Users' parameters: - name: VpnGatewayUserId in: path required: true schema: type: string example: vgwu-00661c58 responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: task_id: type: string example: task-abc123 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/tasks/task-abc123' patch: tags: - 'VPN Gateway Users' parameters: - name: VpnGatewayUserId in: path required: true schema: type: string example: vgwu-00661c58 requestBody: content: application/json: schema: properties: name: type: string example: 'VPN Gateway User Name' description: 'VPN Gateway User' required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vgwu-00661c58 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-users/vgwu-5cfb61e4' '/ecloud/v2/vpn-gateway-users/{VpnGatewayUserId}/credentials': get: tags: - Credentials parameters: - name: credentialId in: path required: true schema: type: string example: cred-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: cred-2b66bb79 name: type: string example: 'Instance Credentials' required: false resource_id: type: string example: i-a63dd78c required: true host: type: string required: false username: type: string required: true password: type: string required: true port: type: integer example: 8080 required: false is_hidden: type: boolean readOnly: false example: false required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' meta: type: object delete: tags: - Credentials parameters: - name: credentialId in: path required: true schema: type: string example: cred-2b66bb79 responses: '204': description: Success patch: tags: - Credentials parameters: - name: credentialId in: path required: true schema: type: string example: cred-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: cred-2b66bb79 name: type: string example: 'Instance Credentials' required: false resource_id: type: string example: i-a63dd78c required: true host: type: string required: false username: type: string required: true password: type: string required: true port: type: integer example: 8080 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Credential required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: cred-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/credentials/cred-6ui8gt89' /ecloud/v2/vpn-gateway-specifications: get: tags: - 'VPN Gateway Specifications' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vgws-2b66bb79 name: type: string readOnly: true example: 'Vpn Gateway Specification Name' description: type: string readOnly: true example: 'Description of the Vpn Gateway Specification' max_users: type: integer description: 'Maximum number of users that can be connected to the Vpn Gateway' readOnly: true example: 10 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway Specification' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications?page=2' '/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}': get: tags: - 'VPN Gateway Specifications' parameters: - name: VpnGatewaySpecificationId in: path required: true schema: type: string example: vgws-2b66bb79 responses: '200': description: Success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vgws-2b66bb79 name: type: string readOnly: true example: 'Vpn Gateway Specification Name' description: type: string readOnly: true example: 'Description of the Vpn Gateway Specification' max_users: type: integer description: 'Maximum number of users that can be connected to the Vpn Gateway' readOnly: true example: 10 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway Specification' meta: type: object '/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}/availability-zones': get: tags: - 'VPN Gateway Specifications' description: 'Get a list of Availability Zones assigned to a VPN Gateway Specification' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: az-2b66bb79 code: type: string example: MAN1 name: type: string example: 'Manchester Region 1' datacentre_site_id: type: integer example: 999 region_id: type: string readOnly: true example: reg-2b66bb79 resource_tier_id: type: string description: 'ID of the default resource tier for the availability zone' readOnly: true example: rt-abc123 state: type: string description: 'Determines whether the availability zone is deployable into, e.g., active, maintenance, deprecated' example: active features: type: array items: type: string example: advanced_networking description: 'List of features enabled for this availability zone' description: 'Availability Zones' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}/availability-zones?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}/availability-zones?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}/availability-zones?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-gateway-specifications/{VpnGatewaySpecificationId}/availability-zones?page=2' /ecloud/v2/vpn-profile-groups: get: tags: - 'Vpn Profile Groups' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpnpg-2b66bb79 name: type: string example: 'My Profile Group' required: true description: type: string example: 'Description of my profile group' required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-profile-groups?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-profile-groups?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-profile-groups?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-profile-groups?page=2' '/ecloud/v2/vpn-profile-groups/{vpnProfileGroupId}': get: tags: - 'Vpn Profile Groups' parameters: - name: vpnProfileGroupId in: path required: true schema: type: string example: vpnpg-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vpnpg-2b66bb79 name: type: string example: 'My Profile Group' required: true description: type: string example: 'Description of my profile group' required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: type: object /ecloud/v2/vpn-services: get: tags: - 'Vpn Service' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-services?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-services?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-services?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-services?page=2' post: tags: - 'Vpn Service' requestBody: content: application/json: schema: properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns required: true responses: '201': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpn-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-services/vpn-6ui8gt89' '/ecloud/v2/vpn-services/{vpnServiceId}': get: tags: - 'Vpn Service' parameters: - name: vpnServiceId in: path required: true schema: type: string example: vpn-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns meta: type: object delete: tags: - 'Vpn Service' parameters: - name: vpnServiceId in: path required: true schema: type: string example: vpn-2b66bb79 responses: '204': description: Success patch: tags: - 'Vpn Service' parameters: - name: vpnServiceId in: path required: true schema: type: string example: vpn-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns - type: object properties: router_id: readOnly: true required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpn-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-services/vpn-6ui8gt89' /ecloud/v2/vpn-sessions: get: tags: - 'Vpn Sessions' parameters: - name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer - name: page in: query description: 'Page number to jump to' required: false schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: properties: id: type: string readOnly: true example: vpns-2b66bb79 name: type: string example: vpns-2b66bb79 required: false vpn_profile_group_id: type: string example: vpnpg-abc123xyz required: true vpn_service_id: type: string example: vpn-abc123xyz required: true vpn_endpoint_id: type: string example: vpne-abc123xyz required: true remote_ip: type: string readOnly: false example: 211.12.13.1 required: true remote_networks: type: string readOnly: false example: 172.12.23.11/32 required: true local_networks: type: string readOnly: false example: '172.11.11.11/32,176.18.22.11/24' required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Vpn Sessions' meta: allOf: - properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string - type: object properties: pagination: properties: links: type: object properties: first: example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions?page=1' previous: example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions?page=1' next: example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions?page=2' last: example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions?page=2' post: tags: - 'Vpn Sessions' requestBody: content: application/json: schema: allOf: - properties: id: type: string readOnly: true example: vpns-2b66bb79 name: type: string example: vpns-2b66bb79 required: false vpn_profile_group_id: type: string example: vpnpg-abc123xyz required: true vpn_service_id: type: string example: vpn-abc123xyz required: true vpn_endpoint_id: type: string example: vpne-abc123xyz required: true remote_ip: type: string readOnly: false example: 211.12.13.1 required: true remote_networks: type: string readOnly: false example: 172.12.23.11/32 required: true local_networks: type: string readOnly: false example: '172.11.11.11/32,176.18.22.11/24' required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Vpn Sessions' - type: object properties: psk: type: string example: str0ngpsk required: true responses: '201': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpns-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions/vpns-6ui8gt89' '/ecloud/v2/vpn-sessions/{vpnSessionId}': get: tags: - 'Vpn Sessions' parameters: - name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: properties: id: type: string readOnly: true example: vpns-2b66bb79 name: type: string example: vpns-2b66bb79 required: false vpn_profile_group_id: type: string example: vpnpg-abc123xyz required: true vpn_service_id: type: string example: vpn-abc123xyz required: true vpn_endpoint_id: type: string example: vpne-abc123xyz required: true remote_ip: type: string readOnly: false example: 211.12.13.1 required: true remote_networks: type: string readOnly: false example: 172.12.23.11/32 required: true local_networks: type: string readOnly: false example: '172.11.11.11/32,176.18.22.11/24' required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Vpn Sessions' meta: type: object delete: tags: - 'Vpn Sessions' parameters: - name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 responses: '204': description: Success patch: tags: - 'Vpn Sessions' parameters: - name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 requestBody: content: application/json: schema: type: object allOf: - properties: id: type: string readOnly: true example: vpns-2b66bb79 name: type: string example: vpns-2b66bb79 required: false vpn_profile_group_id: type: string example: vpnpg-abc123xyz required: true vpn_service_id: type: string example: vpn-abc123xyz required: true vpn_endpoint_id: type: string example: vpne-abc123xyz required: true remote_ip: type: string readOnly: false example: 211.12.13.1 required: true remote_networks: type: string readOnly: false example: 172.12.23.11/32 required: true local_networks: type: string readOnly: false example: '172.11.11.11/32,176.18.22.11/24' required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Vpn Sessions' - type: object properties: vpn_service_id: readOnly: true vpn_endpoint_id: readOnly: true psk: type: string example: str0ngpsk required: true responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpns-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions/vpns-6ui8gt89' '/ecloud/v2/vpn-sessions/{vpnSessionId}/pre-shared-key': get: tags: - 'Vpn Sessions' parameters: - name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 responses: '200': description: success content: application/json: schema: type: object properties: data: type: object properties: psk: type: string readOnly: true example: str0ngpsk meta: type: object put: tags: - 'Vpn Sessions' parameters: - name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 requestBody: content: application/json: schema: allOf: - type: object properties: psk: type: string example: str0ngpsk required: true responses: '202': description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpns-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions/vpns-6ui8gt89' components: schemas: AffinityRule: properties: id: type: string readOnly: true example: ar-2b66bb79 name: type: string readOnly: false example: 'Affinity Rule 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true type: type: string readOnly: false example: anti-affinity required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rules' AffinityRuleMember: properties: id: type: string readOnly: true example: arm-2b66bb79 instance_id: type: string readOnly: false example: i-4c63cf58 affinity_rule_id: type: string readOnly: false example: ar-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Affinity Rule Members' AvailabilityZone: properties: id: type: string readOnly: true example: az-2b66bb79 code: type: string example: MAN1 name: type: string example: 'Manchester Region 1' datacentre_site_id: type: integer example: 999 region_id: type: string readOnly: true example: reg-2b66bb79 resource_tier_id: type: string description: 'ID of the default resource tier for the availability zone' readOnly: true example: rt-abc123 state: type: string description: 'Determines whether the availability zone is deployable into, e.g., active, maintenance, deprecated' example: active features: type: array items: type: string example: advanced_networking description: 'List of features enabled for this availability zone' description: 'Availability Zones' BackupGateway: properties: id: type: string readOnly: true example: bgw-12356 name: type: string example: 'Backup Gateway' required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router assigned to backup gateway' readOnly: true example: rtr-2b66bb79 required: false network_id: type: string description: 'Network assigned to the backup gateway' readOnly: false example: net-abc123 required: true gateway_spec_id: type: string description: 'Gateway spec id assigned to backup gateway' readOnly: false example: bgws-5635 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Backup Gateways' BackupGatewaySpecification: properties: id: type: string readOnly: true example: bgws-3f112f25 name: type: string readOnly: false example: Standard description: type: string readOnly: false example: 'Standard backup gateway, suitable for...' order: type: integer readOnly: false example: 1 description: 'Backup Gateway Specifications' Dhcp: required: [] properties: id: type: string readOnly: true example: dhcp-2b66bb79 name: type: string readOnly: false example: 'My DHCP' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Dhcps DiscountPlan: properties: id: type: string readOnly: true example: disc-2b66bb79 name: type: string example: 'Discount Plan Name' commitment_amount: type: float example: 999.99 commitment_before_discount: type: float example: 999.99 discount_rate: type: float description: 'Numeric percentage discount' example: 5.5 term_length: type: integer description: 'term duration in months' example: 24 term_start_date: type: string example: '2020-07-07T10:30:00+01:00' term_end_date: type: string example: '2020-07-07T10:30:00+01:00' status: type: string example: accepted response_date: type: string example: '2020-07-07T10:30:00+01:00' is_trial: type: boolean readOnly: true example: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Discount Plans' FloatingIP: properties: id: type: string readOnly: true example: fip-2b66bb79 name: type: string readOnly: false example: fip-2b66bb79 vpc_id: type: string readOnly: false example: vpc-2b66bb79 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true ip_address: type: string description: 'The external IP address assigned to the floating IP.' readOnly: true example: 1.1.1.1 resource_id: type: string description: 'ID of the resource that the floating IP is assigned to.' readOnly: true example: ip-abc123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Floating IP addresses' FirewallRule: properties: id: type: string readOnly: true example: fwr-2b66bb79 name: type: string readOnly: false example: 'Internal FW Rule' required: false sequence: type: integer readOnly: false example: 1 required: true firewall_policy_id: type: string readOnly: false example: fwp-abc123xyz required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the firewall rule. This is a full replace. All the port mappings are replaced. Use firewall-rule-ports endpoints to modify individual port mappings.' writeOnly: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallRules FirewallPolicy: properties: id: type: string readOnly: true example: fwp-5b66bb79 name: type: string readOnly: false example: 'My Firewall Policy' required: true sequence: type: integer readOnly: false example: 1 required: true router_id: type: string readOnly: true example: rtr-4c63cf58 required: true type: type: string readOnly: true example: system sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: FirewallPolicies HostGroup: properties: id: type: string readOnly: true example: hg-2b66bb79 name: type: string readOnly: false example: 'Host Group 1' required: false vpc_id: type: string readOnly: false example: vpc-4c63cf58 availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true host_spec_id: type: string description: 'The host spec to use with this host group' readOnly: false example: hs-4c63cf58 required: true windows_enabled: type: boolean description: 'Determines whether the host group contains windows-enabled hosts, defaults to false.' readOnly: false example: true required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true usage: type: object properties: hosts: type: integer description: 'The number of hosts associated with this host group.' example: 10 ram: type: object properties: capacity: type: integer description: 'The total ram capacity in Gb for this host group' example: 2048 reserved: type: integer description: 'The total ram reserved in Gb for this host group' example: 2 used: type: integer description: 'The total ram used in Gb by hosts in this host group' example: 64 available: type: integer description: 'The total ram capacity in Gb available to this host group' example: 1984 vcpu: type: object properties: capacity: type: integer description: 'The total vcpu capacity for this host group' example: 2048 used: type: integer description: 'The total vcpu in use by hosts in this host group' example: 64 available: type: integer description: 'The total vcpu capacity available to this host group' example: 1984 host_limits: type: object properties: ram: type: integer description: 'A single hosts ram limit in Gb' example: 62 vcpu: type: integer description: 'A single hosts vcpu limit' example: 16 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Host Groups' HostSpec: properties: id: type: string readOnly: true example: hs-2b66bb79 name: type: string example: '2 x Hex Core 2Ghz (E5-2620 v1) 64GB' required: false readonly: false cpu_sockets: type: integer description: 'Number of supported CPU sockets' example: 2 required: true readonly: false cpu_type: type: string example: 'E5-2620 v1' required: true readonly: false cpu_cores: type: integer example: 6 required: true readonly: false cpu_clock_speed: type: integer description: 'CPU clock speed in MHz' example: 2000 required: true readonly: false ram_capacity: type: integer description: 'RAM capacity in GB' example: 64 required: true readonly: false description: 'Host Spec' Image: properties: id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'CentOS 7' logo_uri: type: string readOnly: true example: 'https://example.com/image.png' documentation_uri: type: string readOnly: true example: 'https://example.com/docs' vpc_id: type: string description: 'ID of the VPC that the image is assigned to for private images' readOnly: true example: vpc-abc123 description: type: string readOnly: true example: 'Linux operating system' visibility: type: string readOnly: true example: public image_size: type: integer readOnly: true example: 60 platform: type: string readOnly: true example: Linux sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true description: Images ImageMetadata: properties: id: type: string readOnly: true example: imgparam-abc123xyz image_id: type: string readOnly: true example: img-2b66bb79 key: type: string readOnly: true example: ukfast.spec.ram.min value: type: string readOnly: true example: '1024' description: 'Image Parameters' ImageParameter: properties: id: type: string readOnly: true example: imgparam-abc123xyz image_id: type: string readOnly: true example: img-2b66bb79 name: type: string readOnly: true example: 'MySQL root password' key: type: string readOnly: true example: mysql_root_password type: type: string readOnly: true example: Password description: type: string readOnly: true example: 'The root password for the MySQL database' required: type: boolean readOnly: true example: true validation_rule: type: string readOnly: true example: /\\w+/ description: 'Image Parameters' Instance: properties: id: type: string readOnly: true example: i-2b66bb79 name: type: string readOnly: false example: 'My Instance' required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: true image_id: type: string readOnly: false example: img-cf7c54c2 required: true vcpu_cores: type: integer description: 'Total number of VCPU cores the instance has' readOnly: true example: 8 vcpu_sockets: type: integer description: 'Number of VCPU sockets' readOnly: false example: 2 required: true vcpu_cores_per_socket: type: integer description: 'Number of VCPU cores per socket' readOnly: false example: 4 required: true ram_capacity: type: integer description: 'RAM capacity MiB' readOnly: false example: 1024 required: true locked: type: boolean readOnly: false example: false required: false platform: type: string readOnly: false example: Linux required: false backup_enabled: type: boolean description: 'Has the instance got either agent or VM level backups enabled' readOnly: true example: false required: false backup_vm_enabled: type: boolean description: 'VM level backups' readOnly: false example: false required: false backup_agent_enabled: type: boolean description: 'Agent level backups' readOnly: false example: false required: false backup_gateway_id: type: string description: 'Backup gateway ID - required to enable agent level backups' readOnly: false example: bgw-q63772qw required: false monitoring_enabled: type: boolean description: 'Monitoring enabled through a gateway' readOnly: false example: true required: false monitoring_gateway_id: type: string description: 'Monitoring Gateway ID - required to enable monitoring through a gateway' readOnly: false example: mgw-3f112f25 required: false host_group_id: type: string readOnly: false example: hg-abc123 required: false resource_tier_id: type: string description: 'Resource tier for the instance' readOnly: false example: rt-abc123 required: false volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false volume_capacity: type: integer example: 50 required: false volume_iops: type: integer example: 300 required: false is_encrypted: type: boolean description: 'Is the instance encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' network_id: type: string writeOnly: true example: net-912345 required: true floating_ip_id: type: string description: 'ID of existing floating IP to assign to the instance.' writeOnly: true example: fip-912345 required: false requires_floating_ip: type: boolean description: 'Create and assign a new floating IP to the instance.' writeOnly: true example: false required: false image_data: type: json writeOnly: true example: '{"key":"value"}' required: false user_script: type: string writeOnly: true example: '' required: false ssh_key_pair_ids: type: array items: type: string writeOnly: true required: false description: Instances Iops: properties: id: type: string readOnly: true example: iops-2b66bb79 name: type: string readOnly: true example: '300 Iops' required: false level: type: integer readOnly: true example: 300 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Iops LoadBalancer: properties: id: type: string readOnly: true example: lb-2b66bb79 name: type: string example: 'Load Balancer 1' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true load_balancer_spec_id: type: string description: 'Load balancer specification used by the service.' readOnly: false example: lbs-2b66bb79 required: true network_id: type: string description: 'Network assigned to the load balancer service' example: net-abc123 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true config_id: type: string description: 'Load balancer cluster config ID' readOnly: true example: 123 nodes: type: integer description: 'Number of nodes the load balancer has' readOnly: true example: 2 required: false created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Load Balancers' LoadBalancerSpecification: properties: id: type: string readOnly: true example: lbs-0c03049b name: type: string readOnly: false example: small description: type: string readOnly: false example: 'Example description' description: 'Load Balancer Specifications' IpAddress: properties: id: type: string readOnly: true example: ip-2b66bb79 name: type: string readOnly: false example: 'IP Address 1' required: false ip_address: type: string readOnly: false example: 1.1.1.1 required: false network_id: type: string readOnly: false example: net-abc123 required: true type: type: string readOnly: true example: cluster required: false description: 'IP Address' sync: type: object readOnly: true properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update task: type: object readOnly: true properties: in_progress: description: 'Specifies whether a task is in progress for resource' example: true type: boolean created_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true updated_at: type: string example: '2020-07-07T10:30:00+01:00' readOnly: true Meta: properties: pagination: type: object properties: total: type: integer example: 30 count: type: integer example: 10 per_page: type: integer example: 10 current_page: type: integer example: 2 total_pages: type: integer example: 3 links: type: object properties: first: type: string previous: type: string next: type: string last: type: string MonitoringGateway: properties: id: type: string readOnly: true example: mgw-3f112f25 name: type: string example: 'Monitoring Gateway' required: false vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 required: false router_id: type: string description: 'Router the monitoring gateway is assigned to' readOnly: true example: rtr-2b66bb79 required: false specification_id: type: string description: 'Specification id assigned to monitoring gateway' readOnly: true example: mgws-5da6vc35 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Monitoring Gateways' MonitoringGatewaySpecification: properties: id: type: string example: mgws-2b66bb79 name: type: string example: 'Monitoring Gateway Specification Name' description: type: string example: 'Description of the Monitoring Gateway Specification' order: type: integer description: 'Order in which the Monitoring Gateway Specification is displayed and returned by the API' example: 1 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'Monitoring Gateway Specification' Network: properties: id: type: string readOnly: true example: net-2b66bb79 name: type: string example: 'Manchester Network' required: true router_id: type: string example: rtr-4c63cf58 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 subnet: type: string description: 'CIDR format subnet with mask. Minimum network prefix is /29.' example: 10.0.0.0/24 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Networks NetworkPolicy: properties: id: type: string readOnly: true example: np-abc123xyz name: type: string example: 'Default Network Policy' network_id: type: string example: net-912345 required: true vpc_id: type: string readOnly: true example: vpc-2b66bb79 required: true catchall_rule_action: type: string description: 'Action to apply to the catchall rule, allowed options are ALLOW,DROP,REJECT. Default action is REJECT.' writeOnly: true example: ALLOW required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Policies' NetworkRule: properties: id: type: string readOnly: true example: nr-abc123xyz name: type: string readOnly: false example: 'Network Rule' network_policy_id: type: string readOnly: false example: nr-abc123xyz sequence: type: integer readOnly: false example: 1 required: true source: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 1.1.1.1 required: true destination: type: string description: '"ANY" or comma separated list of IPv4, CIDR subnets and/or range boundaries' readOnly: false example: 2.2.2.2 required: true action: type: string description: 'One of ALLOW, DROP, REJECT' readOnly: false example: ALLOW required: true direction: type: string description: 'One of IN, OUT, IN_OUT' readOnly: false example: IN_OUT required: true enabled: type: boolean readOnly: false example: true required: true ports: type: array items: type: object properties: protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '443' required: false destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: '555' required: false description: 'Array of port mappings for the network rule. This is a full replace. All the port mappings are replaced. Use network-rule-ports endpoints to modify individual port mappings.' writeOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule' NetworkRulePort: properties: id: type: string readOnly: true example: nrp-2b66bb79 name: type: string readOnly: false example: '443 to 555' required: false network_rule_id: type: string readOnly: false example: nr-4c63cf58 required: true protocol: type: string description: 'The protocol to use for the port map. TCP or UDP.' example: TCP required: true source: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 443 required: true destination: type: string description: '"ANY" or comma separated list of ports and/or port ranges' example: 555 required: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Network Rule Ports' Nics: properties: id: type: string readOnly: true example: nic-2b66bb79 name: type: string example: 'Nic 1' required: false mac_address: type: string readOnly: false example: '3D:F2:C9:A6:B3:4F' required: true instance_id: type: string readOnly: false example: i-2b66bb79 required: true network_id: type: string readOnly: false example: net-2b66bb79 required: true ip_address: type: string description: 'DHCP IP Address' readOnly: true example: 10.0.0.5 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Nics Region: properties: id: type: string readOnly: true example: reg-2b66bb79 name: type: string example: 'United Kingdom' description: Regions ResourceTier: properties: id: type: string readOnly: true example: rt-2b66bb79 name: type: string readOnly: false example: 'Resource Tier 1' required: false description: type: string readOnly: false example: 'Resource Tier 1 description' required: false availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true cpu: type: object properties: min: type: integer description: 'Minimum total VCPU cores allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum total VCPU cores allowed for instance on this tier' example: 10 readOnly: true cpu_sockets: type: object properties: min: type: integer description: 'Minimum VCPU sockets allowed for instance on this tier' example: 1 max: type: integer description: 'Maximum VCPU sockets allowed for instance on this tier' example: 10 readOnly: true ram: type: object properties: min: type: integer description: 'Minimum RAM MiB allowed for instance on this tier' example: 1024 max: type: integer description: 'Maximum RAM MiB allowed for instance on this tier' example: 131072 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Resource Tiers' Router: properties: id: type: string readOnly: true example: rtr-2b66bb79 name: type: string example: rtr-2b66bb79 required: true vpc_id: type: string example: vpc-2b66bb79 required: true router_throughput_id: type: string description: 'ID of the router throughput profile to assign to the router' example: rtp-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers RouterThroughput: properties: id: type: string readOnly: true example: rtp-2b66bb79 availability_zone_id: type: string description: 'The Availability Zone that this router throughput option is available on' example: az-2b66bb79 required: true name: type: string example: 10Gb required: false committed_bandwidth: type: integer description: 'Bandwidth in Mbps' example: 10240 required: true description: 'Router Throughput' Software: properties: id: type: string readOnly: true example: soft-2b66bb79 name: type: string readOnly: false example: Mcafee required: false platform: type: string readOnly: false example: Linux required: true description: Software SSHKeyPair: properties: id: type: string readOnly: true example: ssh-2b66bb79 name: type: string example: mykey public_key: type: string example: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDFnKEoztA5+jy3u/uQ9eLhFbMKuCMvZFkflRPtYu0zcq1pkjGZZ5BrOJgLu36eGvVIqZBgtaFefmCVVKZyqXfQ8v/uXb/Liv5HqmFquLq8F/80GJ7djYqL0ZzHxkAdGEWikeN3kbcZOHG2MvFpTlg7IVuh7lujRMYklJbG3P9azQ==' created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: SSHKeyPair Tag: properties: id: type: string readOnly: true example: tag-9fcb2a3c name: type: string example: 'My Tag' scope: type: string nullable: true example: global created_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2025-07-07T10:30:00+01:00' description: Tag Task: properties: id: type: string readOnly: true example: task-2b66bb79 name: type: string readOnly: true example: some_task status: type: string readOnly: true example: complete created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Tasks VirtualPrivateCloud: properties: id: type: string readOnly: true example: vpc-2b66bb79 name: type: string example: 'Manchester Cloud 1' client_id: type: integer description: 'The ID of the client this resource is assigned to.' example: 123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true region_id: type: string example: reg-a63dd78c required: true support_enabled: type: boolean example: true console_enabled: type: boolean readOnly: true example: true advanced_networking: type: boolean example: true required: false draas: type: object properties: enabled: type: boolean description: 'The status of the disaster recovery service on the resource.' readOnly: true example: true id: type: string description: 'The ID of the related DRaaS Tenant.' readOnly: true example: 4235bfee-5b09-46ab-9577-c2cec88777b4 readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Virtual Private Clouds' Volume: properties: id: type: string readOnly: true example: vol-2b66bb79 name: type: string example: vol-2b66bb79 required: false vpc_id: type: string example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true capacity: type: integer description: 'Volume capacity in GB' example: 250 required: true iops: type: integer description: 'IOPS value 300, 600, 1200 or 2500 only' example: 300 required: false attached: type: boolean description: 'Is the volume attached to a resource' readOnly: true example: true volume_group_id: type: string readOnly: false example: volgroup-2b66bb79 required: false is_shared: type: boolean description: 'Is the volume a shared resource' example: true required: false is_encrypted: type: boolean description: 'Is the volume encrypted' readOnly: true example: false required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true type: type: string description: 'Is the volume an OS volume' readOnly: true example: os created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Routers VolumeGroups: properties: id: type: string readOnly: true example: volgroup-2b66bb79 name: type: string example: volgroup-2b66bb79 required: false vpc_id: type: string readOnly: false example: vpc-2b66bb79 required: true availability_zone_id: type: string readOnly: false example: az-2b66bb79 required: true usage: type: object properties: volumes: type: integer description: 'The number of volumes associated with this volume group.' example: 10 readOnly: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns VpnEndpoint: properties: id: type: string readOnly: true example: vpne-2b66bb79 name: type: string example: vpne-2b66bb79 required: false vpn_service_id: type: string readOnly: false example: vpn-2b66bb79 required: true floating_ip_id: type: string readOnly: false example: fip-2b66bb79 required: false sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns VpnGateway: properties: id: type: string readOnly: true example: vgw-00661c58 name: type: string example: 'VPN Gateway Name' availability_zone_id: type: string description: 'ID of the Availability Zone that the VPN Gateway will use' readOnly: true example: az-2b66bb79 router_id: type: string description: 'ID of the Router that the VPN Gateway will use' example: rtr-2b66bb79 specification_id: type: string description: 'ID of the VPN Gateway Specification that the VPN Gateway will use' example: vgws-2b66bb79 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway' VpnGatewayUser: properties: id: type: string readOnly: true example: vgwu-00661c58 name: type: string example: 'VPN Gateway User Name' vpn_gateway_id: type: string description: 'ID of the VPN Gateway that the User will be on' example: vgw-2b66bb79 username: type: string description: 'The username of the VPN Gateway User' writeOnly: true example: vpn_user password: type: string description: 'The password of the VPN Gateway User' writeOnly: true example: password123 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway User' VpnGatewaySpecification: properties: id: type: string readOnly: true example: vgws-2b66bb79 name: type: string readOnly: true example: 'Vpn Gateway Specification Name' description: type: string readOnly: true example: 'Description of the Vpn Gateway Specification' max_users: type: integer description: 'Maximum number of users that can be connected to the Vpn Gateway' readOnly: true example: 10 created_at: type: string readOnly: true example: '2024-08-08T10:30:00+01:00' updated_at: type: string readOnly: true example: '2024-08-09T10:30:00+01:00' description: 'VPN Gateway Specification' VpnProfileGroup: properties: id: type: string readOnly: true example: vpnpg-2b66bb79 name: type: string example: 'My Profile Group' required: true description: type: string example: 'Description of my profile group' required: true availability_zone_id: type: string readOnly: true example: az-2b66bb79 created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns VpnService: properties: id: type: string readOnly: true example: vpn-2b66bb79 name: type: string example: 'Office VPN' required: true router_id: type: string readOnly: false example: rtr-2b66bb79 required: true vpc_id: type: string readOnly: true example: vpc-4c63cf58 sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: Vpns VpnSession: properties: id: type: string readOnly: true example: vpns-2b66bb79 name: type: string example: vpns-2b66bb79 required: false vpn_profile_group_id: type: string example: vpnpg-abc123xyz required: true vpn_service_id: type: string example: vpn-abc123xyz required: true vpn_endpoint_id: type: string example: vpne-abc123xyz required: true remote_ip: type: string readOnly: false example: 211.12.13.1 required: true remote_networks: type: string readOnly: false example: 172.12.23.11/32 required: true local_networks: type: string readOnly: false example: '172.11.11.11/32,176.18.22.11/24' required: true sync: type: object properties: status: description: 'The status of the most recent sync performed on the resource. Possible values: in-progress, failed, complete.' example: complete type: description: 'The type of the most recent sync performed on the resource. Possible values: update / delete.' example: update readOnly: true task: type: object properties: in_progress: type: boolean description: 'Specifies whether a task is in progress for resource' example: true readOnly: true created_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' updated_at: type: string readOnly: true example: '2020-07-07T10:30:00+01:00' description: 'Vpn Sessions' responses: DhcpIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: dhcp-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/dhcps/dhcp-6ui8gt89' DiscountPlanResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: disc-2b66bb79 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/discount-plans/disc-2b66bb79' FirewallPolicyIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: fwp-4f22694 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/firewall-policies/fwp-4f22694' NetworkPolicyIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: np-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-policies/np-abc123xyz' NetworkRulePortIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nrp-3f112f25 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rule-ports/nrp-3f112f25' NetworkRuleIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: nr-abc123xyz task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/network-rules/nr-abc123xyz' RouterIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: rtr-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/routers/rtr-6ui8gt89' VolumeGroupIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/volume-groups/volgroup-6ui8gt89' VpnEndpointIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpne-6ui8gt89 task_id: type: string example: task-abc123xyz meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-endpoints/vpne-6ui8gt89' VpnProfileGroupIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpnpg-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-profile-groups/vpnpg-6ui8gt89' VpnServiceIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpn-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-services/vpn-6ui8gt89' VpnSessionIdResponse: description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string example: vpns-6ui8gt89 meta: type: object properties: location: type: string example: 'https://api.ukfast.io/ecloud/v2/vpn-sessions/vpns-6ui8gt89' parameters: AffinityRuleId: name: id in: path required: true schema: type: string example: ar-3f112f25 AffinityRuleMemberId: name: id in: path required: true schema: type: string example: arm-3f112f25 AvailabilityZoneId: name: AvailabilityZoneId in: path required: true schema: type: string example: az-2b66bb79 BackupGatewayId: name: id in: path required: true schema: type: string example: bgw-3f112f25 BackupGatewaySpecificationId: name: bgwsId in: path required: true schema: type: string example: bgws-3f112f25 DhcpId: name: dhcpId in: path required: true schema: type: string example: dhcp-2b66bb79 DiscountPlanId: name: DiscountPlanId in: path required: true schema: type: string example: disc-2b66bb79 FirewallPolicyId: name: firewallPolicyId in: path required: true schema: type: string example: fwp-d4226940 IopsId: name: iopsId in: path required: true schema: type: string example: iops-3f112f25 LoadBalancerSpecificationId: name: lbsId in: path required: true schema: type: string example: lbs-0c03049b NetworkPolicyId: name: NetworkPolicyId in: path required: true schema: type: string example: np-abc123xyz NetworkRulePortId: name: networkRulePortId in: path required: true schema: type: string example: nrp-3f112f25 NetworkRuleId: name: NetworkRuleId in: path required: true schema: type: string example: nr-abc123xyz RegionId: name: regionId in: path required: true schema: type: string example: reg-cd226940 RouterId: name: routerId in: path required: true schema: type: string example: rtr-2b66bb79 VolumeGroupId: name: volumeGroupId in: path required: true schema: type: string example: volgroup-2b66bb79 VpcId: name: vpcId in: path required: true schema: type: string example: vpc-2b66bb79 VpnEndpointId: name: vpnId in: path required: true schema: type: string example: vpne-2b66bb79 VpnProfileGroupId: name: vpnProfileGroupId in: path required: true schema: type: string example: vpnpg-2b66bb79 VpnServiceId: name: vpnServiceId in: path required: true schema: type: string example: vpn-2b66bb79 VpnSessionId: name: vpnSessionId in: path required: true schema: type: string example: vpns-2b66bb79 PerPage: name: per_page in: query description: 'Number of items to display per page' required: false schema: type: integer Page: name: page in: query description: 'Page number to jump to' required: false schema: type: integer securitySchemes: api_key: type: apiKey description: 'API key authentication' name: Authorization in: header security: - api_key: - api_key