openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Worker Account Settings API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Worker Account Settings paths: /accounts/{account_id}/workers/account-settings: get: description: Fetches Worker account settings for an account. operationId: worker-account-settings-fetch-worker-account-settings parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_account-settings-response' - $ref: '#/components/schemas/workers_api-response-common-failure' description: Fetch Worker Account Settings response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers_account-settings-response' description: Fetch Worker Account Settings response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Fetch Worker Account Settings tags: - Worker Account Settings x-api-token-group: - Cloudflare Zero Trust PII Read - DDoS Botnet Feed Write - DDoS Botnet Feed Read - Workers R2 Storage Write - Workers R2 Storage Read - DDoS Protection Write - DDoS Protection Read - Workers Tail Read - Workers KV Storage Write - Workers KV Storage Read - Workers Scripts Write - Workers Scripts Read - 'Load Balancing: Monitors and Pools Write' - 'Load Balancing: Monitors and Pools Read' - Account Firewall Access Rules Write - Account Firewall Access Rules Read - DNS Firewall Write - DNS Firewall Read - Billing Write - Billing Read - Account Settings Write - Account Settings Read x-cfPermissionsRequired: enum: - com.cloudflare.api.account.read put: description: Creates Worker account settings for an account. operationId: worker-account-settings-create-worker-account-settings parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/workers_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/workers_account-settings' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/workers_account-settings-response' - $ref: '#/components/schemas/workers_api-response-common-failure' description: Create Worker Account Settings response failure '200': content: application/json: schema: $ref: '#/components/schemas/workers_account-settings-response' description: Create Worker Account Settings response security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create Worker Account Settings tags: - Worker Account Settings x-api-token-group: - Account Settings Write x-cfPermissionsRequired: enum: - com.cloudflare.api.account.update components: schemas: workers_identifier: description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 type: string workers_account-settings: properties: default_usage_model: type: string green_compute: type: boolean type: object workers_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array workers_api-response-common: properties: errors: $ref: '#/components/schemas/workers_messages' messages: $ref: '#/components/schemas/workers_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object workers_account-settings-response: allOf: - $ref: '#/components/schemas/workers_api-response-common' - properties: result: $ref: '#/components/schemas/workers_account-settings' workers_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/workers_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/workers_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true