APIs.io Engineering Platform Access Bookmark Applications (Deprecated) API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Access Bookmark Applications (Deprecated) API
  version: 4.0.0
tags:
- name: Access Bookmark Applications (Deprecated)
paths:
  /accounts/{account_id}/access/bookmarks:
    get:
      deprecated: true
      description: Lists Bookmark applications.
      operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: List Bookmark applications response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-response_collection'
          description: List Bookmark applications response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Bookmark applications
      tags:
      - Access Bookmark Applications (Deprecated)
      x-api-token-group:
      - 'Access: Apps and Policies Revoke'
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: '2023-03-19'
        id: bookmarks_deprecation
  /accounts/{account_id}/access/bookmarks/{bookmark_id}:
    delete:
      deprecated: true
      description: Deletes a Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application
      parameters:
      - in: path
        name: bookmark_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Delete a Bookmark application response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
          description: Delete a Bookmark application response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Bookmark application
      tags:
      - Access Bookmark Applications (Deprecated)
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: '2023-03-19'
        id: bookmarks_deprecation
    get:
      deprecated: true
      description: Fetches a single Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application
      parameters:
      - in: path
        name: bookmark_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get a Bookmark application response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Get a Bookmark application response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a Bookmark application
      tags:
      - Access Bookmark Applications (Deprecated)
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: '2023-03-19'
        id: bookmarks_deprecation
    post:
      deprecated: true
      description: Create a new Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application
      parameters:
      - in: path
        name: bookmark_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Create a Bookmark application response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Create a Bookmark application response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a Bookmark application
      tags:
      - Access Bookmark Applications (Deprecated)
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: '2023-03-19'
        id: bookmarks_deprecation
    put:
      deprecated: true
      description: Updates a configured Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application
      parameters:
      - in: path
        name: bookmark_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a Bookmark application response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
          description: Update a Bookmark application response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Bookmark application
      tags:
      - Access Bookmark Applications (Deprecated)
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-cfDeprecation:
        description: This endpoint is deprecated in favor of using a specialized Access Application App Type.
        display: true
        eol: '2023-03-19'
        id: bookmarks_deprecation
components:
  schemas:
    access_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    access_bookmarks:
      properties:
        app_launcher_visible:
          $ref: '#/components/schemas/access_schemas-app_launcher_visible'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        domain:
          $ref: '#/components/schemas/access_schemas-domain'
        id:
          description: The unique identifier for the Bookmark application.
          type: string
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_bookmarks_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_id_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/access_uuid'
            type: object
    access_bookmarks_components-schemas-name:
      description: The name of the Bookmark application.
      example: My Website
      type: string
    access_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    access_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      type: object
    access_logo_url:
      description: The image URL for the logo shown in the App Launcher dashboard.
      example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg
      type: string
    access_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    access_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/access_result_info'
      type: object
    access_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_bookmarks_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_bookmarks'
    access_bookmarks_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_bookmarks'
            type: array
    access_schemas-app_launcher_visible:
      description: Displays the application in the App Launcher.
      example: true
      type: boolean
    access_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    access_schemas-domain:
      description: The domain of the Bookmark application.
      example: example.com
      type: string
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey