APIs.io Engineering Platform Pages Project API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Pages Project API
  description: <fullname>Amazon API Gateway</fullname> <p>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.</p>
  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
    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: Pages Project
paths:
  /accounts/{account_id}/pages/projects:
    get:
      description: Fetch a list of all user projects.
      operationId: pages-project-get-projects
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_projects-response'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get projects response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_projects-response'
          description: Get projects response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get projects
      tags:
      - Pages Project
    post:
      description: Create a new project.
      operationId: pages-project-create-project
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_project-object'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_project-response'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Create project response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Create project response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create project
      tags:
      - Pages Project
  /accounts/{account_id}/pages/projects/{project_name}:
    delete:
      description: Delete a project by name.
      operationId: pages-project-delete-project
      parameters:
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result: null
                    success: true
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Delete project response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_api-response-common'
                - properties:
                    result:
                      nullable: true
                      type: object
                  type: object
          description: Delete project response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete project
      tags:
      - Pages Project
    get:
      description: Fetch a project by name.
      operationId: pages-project-get-project
      parameters:
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_project-response'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get project response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Get project response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get project
      tags:
      - Pages Project
    patch:
      description: Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.
      operationId: pages-project-update-project
      parameters:
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_project-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_project-response'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Update project response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_project-response'
          description: Update project response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update project
      tags:
      - Pages Project
components:
  schemas:
    pages_project-response:
      allOf:
      - $ref: '#/components/schemas/pages_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/pages_project-object'
    pages_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/pages_messages'
          example:
          - code: 7003
            message: No route for the URI.
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/pages_messages'
          example: []
        result:
          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
    pages_deployment_configs_values:
      properties:
        ai_bindings:
          additionalProperties:
            description: AI binding.
            nullable: true
            properties:
              project_id:
                type: string
            type: object
          description: Constellation bindings used for Pages Functions.
          example:
            AI_BINDING:
              project_id: some-project-id
          nullable: true
          type: object
        analytics_engine_datasets:
          additionalProperties:
            description: Analytics Engine binding.
            nullable: true
            properties:
              dataset:
                description: Name of the dataset.
                example: api_analytics
                type: string
            type: object
          description: Analytics Engine bindings used for Pages Functions.
          example:
            ANALYTICS_ENGINE_BINDING:
              dataset: api_analytics
          nullable: true
          type: object
        browsers:
          additionalProperties:
            description: Browser binding.
            nullable: true
            type: object
          description: Browser bindings used for Pages Functions.
          example:
            BROWSER: {}
          nullable: true
          type: object
        compatibility_date:
          description: Compatibility date used for Pages Functions.
          example: '2022-01-01'
          type: string
        compatibility_flags:
          description: Compatibility flags used for Pages Functions.
          example:
          - url_standard
          items:
            type: string
          type: array
        d1_databases:
          additionalProperties:
            description: D1 binding.
            nullable: true
            properties:
              id:
                description: UUID of the D1 database.
                example: 445e2955-951a-43f8-a35b-a4d0c8138f63
                type: string
            type: object
          description: D1 databases used for Pages Functions.
          example:
            D1_BINDING:
              id: 445e2955-951a-43f8-a35b-a4d0c8138f63
          nullable: true
          type: object
        durable_object_namespaces:
          additionalProperties:
            description: Durabble Object binding.
            nullable: true
            properties:
              namespace_id:
                description: ID of the Durabble Object namespace.
                example: 5eb63bbbe01eeed093cb22bb8f5acdc3
                type: string
            type: object
          description: Durabble Object namespaces used for Pages Functions.
          example:
            DO_BINDING:
              namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
          nullable: true
          type: object
        env_vars:
          additionalProperties:
            description: Environment variable.
            example:
              type: plain_text
              value: hello world
            nullable: true
            properties:
              type:
                description: The type of environment variable.
                enum:
                - plain_text
                - secret_text
                type: string
              value:
                description: Environment variable value.
                type: string
            required:
            - value
            type: object
          description: Environment variables for build configs.
          nullable: true
          type: object
        hyperdrive_bindings:
          additionalProperties:
            description: Hyperdrive binding.
            nullable: true
            properties:
              id:
                example: a76a99bc342644deb02c38d66082262a
                type: string
            type: object
          description: Hyperdrive bindings used for Pages Functions.
          example:
            HYPERDRIVE:
              id: a76a99bc342644deb02c38d66082262a
          nullable: true
          type: object
        kv_namespaces:
          additionalProperties:
            description: KV namespace binding.
            nullable: true
            properties:
              namespace_id:
                description: ID of the KV namespace.
                example: 5eb63bbbe01eeed093cb22bb8f5acdc3
                type: string
            type: object
          description: KV namespaces used for Pages Functions.
          example:
            KV_BINDING:
              namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
          nullable: true
          type: object
        mtls_certificates:
          additionalProperties:
            description: mTLS binding.
            nullable: true
            properties:
              certificate_id:
                example: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
                type: string
            type: object
          description: mTLS bindings used for Pages Functions.
          example:
            MTLS:
              certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
          nullable: true
          type: object
        placement:
          description: Placement setting used for Pages Functions.
          example:
            mode: smart
          nullable: true
          properties:
            mode:
              description: Placement mode.
              example: smart
              type: string
          type: object
        queue_producers:
          additionalProperties:
            description: Queue Producer binding.
            nullable: true
            properties:
              name:
                description: Name of the Queue.
                example: some-queue
                type: string
            type: object
          description: Queue Producer bindings used for Pages Functions.
          example:
            QUEUE_PRODUCER_BINDING:
              name: some-queue
          nullable: true
          type: object
        r2_buckets:
          additionalProperties:
            description: R2 binding.
            nullable: true
            properties:
              jurisdiction:
                description: Jurisdiction of the R2 bucket.
                example: eu
                nullable: true
                type: string
              name:
                description: Name of the R2 bucket.
                example: some-bucket
                type: string
            type: object
          description: R2 buckets used for Pages Functions.
          example:
            R2_BINDING:
              name: some-bucket
          nullable: true
          type: object
        services:
          additionalProperties:
            description: Service binding.
            nullable: true
            properties:
              entrypoint:
                description: The entrypoint to bind to.
                nullable: true
                type: string
              environment:
                description: The Service environment.
                type: string
              service:
                description: The Service name.
                type: string
            type: object
          description: Services used for Pages Functions.
          example:
            SERVICE_BINDING:
              entrypoint: MyHandler
              environment: production
              service: example-worker
          nullable: true
          type: object
        vectorize_bindings:
          additionalProperties:
            description: Vectorize binding.
            nullable: true
            properties:
              index_name:
                example: my_index
                type: string
            type: object
          description: Vectorize bindings used for Pages Functions.
          example:
            VECTORIZE:
              index_name: my_index
          nullable: true
          type: object
      type: object
    pages_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/pages_messages'
        messages:
          $ref: '#/components/schemas/pages_messages'
        success:
          description: Whether the API call was successful
          enum:
          - false
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    pages_project-object:
      properties:
        build_config:
          $ref: '#/components/schemas/pages_build_config'
        canonical_deployment:
          allOf:
          - $ref: '#/components/schemas/pages_deployments'
          - description: Most recent deployment to the repo.
            nullable: true
            readOnly: true
            type: object
        created_on:
          description: When the project was created.
          example: '2017-01-01T00:00:00Z'
          format: date-time
          readOnly: true
          type: string
        deployment_configs:
          $ref: '#/components/schemas/pages_deployment_configs'
        domains:
          description: A list of associated custom domains for the project.
          example:
          - customdomain.com
          - customdomain.org
          items:
            type: string
          readOnly: true
          type: array
        id:
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
          type: string
        latest_deployment:
          allOf:
          - $ref: '#/components/schemas/pages_deployments'
          - description: Most recent deployment to the repo.
            nullable: true
            readOnly: true
            type: object
        name:
          description: Name of the project.
          example: NextJS Blog
          type: string
        production_branch:
          description: Production branch of the project. Used to identify production deployments.
          example: main
          type: string
        source:
          $ref: '#/components/schemas/pages_source'
        subdomain:
          description: The Cloudflare subdomain associated with the project.
          example: helloworld.pages.dev
          readOnly: true
          type: string
      type: object
    pages_deployment_configs:
      description: Configs for deployments in a project.
      properties:
        preview:
          anyOf:
          - $ref: '#/components/schemas/pages_deployment_configs_values'
          description: Configs for preview deploys.
          type: object
        production:
          anyOf:
          - $ref: '#/components/schemas/pages_deployment_configs_values'
          description: Configs for production deploys.
          type: object
      type: object
    pages_deployments:
      properties:
        aliases:
          description: A list of alias URLs pointing to this deployment.
          example:
          - https://branchname.projectname.pages.dev
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        build_config:
          $ref: '#/components/schemas/pages_build_config'
        created_on:
          description: When the deployment was created.
          example: '2021-03-09T00:55:03.923456Z'
          format: date-time
          readOnly: true
          type: string
        deployment_trigger:
          description: Info about what caused the deployment.
          properties:
            metadata:
              description: Additional info about the trigger.
              properties:
                branch:
                  description: Where the trigger happened.
                  example: main
                  readOnly: true
                  type: string
                commit_hash:
                  description: Hash of the deployment trigger commit.
                  example: ad9ccd918a81025731e10e40267e11273a263421
                  readOnly: true
                  type: string
                commit_message:
                  description: Message of the deployment trigger commit.
                  example: Update index.html
                  readOnly: true
                  type: string
              type: object
            type:
              description: What caused the deployment.
              example: ad_hoc
              pattern: push|ad_hoc
              readOnly: true
              type: string
          readOnly: true
          type: object
        env_vars:
          additionalProperties:
            description: Environment variable.
            nullable: true
            properties:
              type:
                description: The type of environment variable.
                type: string
              value:
                description: Environment variable value.
                type: string
            required:
            - value
            type: object
          description: A dict of env variables to build this deploy.
          example:
            BUILD_VERSION:
              value: '3.3'
            ENV:
              value: STAGING
          readOnly: true
          type: object
        environment:
          description: Type of deploy.
          example: preview
          pattern: preview|production
          readOnly: true
          type: string
        id:
          description: Id of the deployment.
          example: f64788e9-fccd-4d4a-a28a-cb84f88f6
          readOnly: true
          type: string
        is_skipped:
          description: If the deployment has been skipped.
          example: true
          readOnly: true
          type: boolean
        latest_stage:
          $ref: '#/components/schemas/pages_stage'
        modified_on:
          description: When the deployment was last modified.
          example: 2021-03-09 00:58:59.045655
          format: date-time
          readOnly: true
          type: string
        project_id:
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
          type: string
        project_name:
          description: Name of the project.
          example: ninjakittens
          readOnly: true
          type: string
        short_id:
          description: Short Id (8 character) of the deployment.
          example: f64788e9
          readOnly: true
          type: string
        source:
          $ref: '#/components/schemas/pages_source'
        stages:
          description: List of past stages.
          example:
          - ended_on: '2021-06-03T15:39:03.134378Z'
            name: queued
            started_on: '2021-06-03T15:38:15.608194Z'
            status: active
          - ended_on: null
            name: initialize
            started_on: null
            status: idle
          - ended_on: null
            name: clone_repo
            started_on: null
            status: idle
          - ended_on: null
            name: build
            started_on: null
            status: idle
          - ended_on: null
            name: deploy
            started_on: null
            status: idle
          items:
            $ref: '#/components/schemas/pages_stage'
          readOnly: true
          type: array
        url:
          description: The live URL to view this deployment.
          example: https://f64788e9.ninjakittens.pages.dev
          readOnly: true
          type: string
      type: object
    pages_project-patch:
      allOf:
      - $ref: '#/components/schemas/pages_project-object'
      - example:
          deployment_configs:
            production:
              compatibility_date: '2022-01-01'
              compatibility_flags:
              - url_standard
              env_vars:
                BUILD_VERSION:
                  value: '3.3'
                delete_this_env_var: null
                secret_var:
                  type: secret_text
                  value: A_CMS_API_TOKEN
        type: object
    pages_api-response-pagination:
      properties:
        result_info:
          properties:
            count:
              description: The number of items on the current page.
              example: 1
              type: integer
            page:
              description: The page currently being requested.
              example: 1
              type: integer
            per_page:
              description: The number of items per page being returned.
              example: 100
              type: integer
            total_count:
              description: The total count of items.
              example: 1
              type: integer
            total_pages:
              description: The total count of pages.
              example: 1
              type: integer
          required:
          - page
          - per_page
          - count
          - total_count
          type: object
      type: object
    pages_projects-response:
      allOf:
      - $ref: '#/components/schemas/pages_api-response-common'
      - $ref: '#/components/schemas/pages_api-response-pagination'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/pages_deployments'
            type: array
    pages_source:
      properties:
        config:
          properties:
            deployments_enabled:
              type: boolean
            owner:
              type: string
            path_excludes:
              items:
                type: string
              type: array
            path_includes:
              items:
                type: string
              type: array
            pr_comments_enabled:
              type: boolean
            preview_branch_excludes:
              items:
                type: string
              type: array
            preview_branch_includes:
              items:
                type: string
              type: array
            preview_deployment_setting:
              enum:
              - all
              - none
              - custom
              type: string
            production_branch:
              type: string
            production_deployments_enabled:
              type: boolean
            repo_name:
              type: string
          type: object
        type:
          type: string
      readOnly: true
      type: object
    pages_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    pages_build_config:
      description: Configs for the project build process.
      properties:
        build_caching:
          description: Enable build caching for the project.
          example: true
          nullable: true
          type: boolean
        build_command:
          description: Command used to build project.
          example: npm run build
          nullable: true
          type: string
        destination_dir:
          description: Output directory of the build.
          example: build
          nullable: true
          type: string
        root_dir:
          description: Directory to run the command.
          example: /
          nullable: true
          type: string
        web_analytics_tag:
          description: The classifying tag for analytics.
          example: cee1c73f6e4743d0b5e6bb1a0bcaabcc
          nullable: true
          type: string
        web_analytics_token:
          description: The auth token for analytics.
          example: 021e1057c18547eca7b79f2516f06o7x
          nullable: true
          type: string
      type: object
    pages_project_name:
      description: Name of the project.
      example: this-is-my-project-01
      pattern: ^[a-z0-9][a-z0-9-]*$
      type: string
    pages_stage:
      description: The status of the deployment.
      properties:
        ended_on:
          description: When the stage ended.
          example: 2021-03-09 00:58:59.045655
          format: date-time
          nullable: true
          readOnly: true
          type: string
        name:
          description: The current build stage.
          example: deploy
          pattern: queued|initialize|clone_repo|build|deploy
          type: string
        started_on:
          description: When the stage started.
          example: '2021-03-09T00:55:03.923456Z'
          format: date-time
          nullable: true
          readOnly: true
          type: string
        status:
          description: State of the current stage.
          example: success
          pattern: success|idle|active|failure|canceled
          readOnly: true
          type: string
      readOnly: true
      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