Skip to content

Location

Tip

Location is an internal name. In the UI and elsewhere, this is Region.

Location

Node

Region

List All Locations

GET /api/admin/locations

Schema
  • locations: Array
    • id: Integer
    • name: String
    • fill_strategy: String - least or full. Full will fill to the fill_to variable on the region (AZ).
    • created_at: DateTime
    • updated_at: DateTime

View Location

GET /api/admin/locations/{id}

Schema
  • location: Object
    • id: Integer
    • name: String
    • fill_strategy: String - least or full. Full will fill to the fill_to variable on the region (AZ).
    • created_at: DateTime
    • updated_at: DateTime

Update Location

PATCH /api/admin/locations/{id}

Schema
  • location: Object
    • name: String
    • fill_strategy: String - least or full. Full will fill to the fill_to variable on the region (AZ).

Create Location

POST /api/admin/locations

Schema
  • location: Object
    • name: String
    • fill_strategy: String - least or full. Full will fill to the fill_to variable on the region (AZ).

Delete Location

DELETE /api/admin/locations/{id}

Show Location Resource Allocation

GET /api/admin/locations/{location_id}/allocated_resources

Schema
  • total: Hash
    • containers: Integer
    • sftp_containers: Integer
    • cpu: Float (CORES)
    • memory: Integer (MB)
  • availability_zones: Array
    • id: Integer
    • name: String
    • allocated: Hash
      • containers: Integer
      • sftp_containers: Integer
      • cpu: Float (CORES)
      • memory: Integer (MB)
    • projects: Array
      • id: Integer
      • name: String