get: operationId: GetRegions summary: List Regions description: >- Retrieve a list of Regions. The regions can be filtered by fields such as `created_at`. The regions can also be paginated x-authenticated: true parameters: - in: query name: limit schema: type: integer default: 50 required: false description: Limit the number of regions returned. - in: query name: offset schema: type: integer default: 0 required: false description: The number of regions to skip when retrieving the regions. - in: query name: created_at required: false description: Filter by a creation date range. schema: type: object properties: lt: type: string description: filter by dates less than this date format: date gt: type: string description: filter by dates greater than this date format: date lte: type: string description: filter by dates less than or equal to this date format: date gte: type: string description: filter by dates greater than or equal to this date format: date - in: query name: updated_at required: false description: Filter by an update date range. schema: type: object properties: lt: type: string description: filter by dates less than this date format: date gt: type: string description: filter by dates greater than this date format: date lte: type: string description: filter by dates less than or equal to this date format: date gte: type: string description: filter by dates greater than or equal to this date format: date - in: query name: deleted_at required: false description: Filter by a deletion date range. schema: type: object properties: lt: type: string description: filter by dates less than this date format: date gt: type: string description: filter by dates greater than this date format: date lte: type: string description: filter by dates less than or equal to this date format: date gte: type: string description: filter by dates greater than or equal to this date format: date x-codegen: method: list queryParams: AdminGetRegionsParams x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions/get.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_regions/get.sh security: - api_token: [] - cookie_auth: [] tags: - Regions responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminRegionsListRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml post: operationId: PostRegions summary: Create a Region description: Create a Region. x-authenticated: true requestBody: content: application/json: schema: $ref: ../components/schemas/AdminPostRegionsReq.yaml x-codegen: method: create x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/admin_regions/post.js - lang: Shell label: cURL source: $ref: ../code_samples/Shell/admin_regions/post.sh security: - api_token: [] - cookie_auth: [] tags: - Regions responses: '200': description: OK content: application/json: schema: $ref: ../components/schemas/AdminRegionsRes.yaml '400': $ref: ../components/responses/400_error.yaml '401': $ref: ../components/responses/unauthorized.yaml '404': $ref: ../components/responses/not_found_error.yaml '409': $ref: ../components/responses/invalid_state_error.yaml '422': $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml