> ## Documentation Index
> Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt
> Use this file to discover all available pages before exploring further.

# [Cloudflare] Retrieve the connected Cloudflare account

> Return the Cloudflare account connected to this project, or `connection: null` when none is. Tokens are never returned. `connected_by` is only shown to the organization's owners: it is null for other members, project guests and project-scoped API keys.



## OpenAPI

````yaml https://api.onetsolutions.net/schema get /v1/organizations/{organization_id}/projects/{project_id}/integrations/cloudflare
openapi: 3.0.3
info:
  title: OnetSolutions API
  version: v1 (v1)
  description: >

    ## Overview


    The OnetSolutions API provides programmatic access to manage your cloud
    infrastructure, domains, and web hosting services.


    ## Authentication


    All API requests require authentication using one of the following methods:


    - **JWT Token**: Obtain a token via login endpoints and include it in the
    `Authorization: Bearer <token>` header

    - **API Key**: Generate an API key from your account settings and use it as
    `Authorization: Bearer sk-onetsolutions-...`


    ## Rate Limiting


    API requests are rate-limited to ensure fair usage:

    - **Anonymous**: 60 requests per minute, per client IP address

    - **Authenticated**: 5000 requests per hour, per user


    Some endpoints, such as login and sign-up, apply stricter limits of their
    own.

    A request over the limit gets a `429` response whose `Retry-After` header
    gives the wait in seconds.


    ## Pagination


    Most list endpoints return paginated results. Use the `page` and `page_size`
    query parameters

    (at most 100 results per page). The response carries `count`, `next`,
    `previous`, `page`, `page_size`,

    `total_pages` and the `results` themselves.


    ## Error Handling


    The API uses standard HTTP status codes:

    - `200` Success

    - `201` Created

    - `204` No Content

    - `400` Bad Request

    - `401` Unauthorized

    - `403` Forbidden

    - `404` Not Found

    - `409` Conflict

    - `429` Too Many Requests

    - `500` Internal Server Error

    - `503` Service Unavailable


    Error responses carry a JSON body with `detail`, a human-readable message,
    and `code`, a stable

    machine-readable error code. Some errors add `context` with structured
    details, and `error`

    repeats `detail` for older clients. A request whose fields fail validation
    gets a `400` whose body maps each

    invalid field to its list of messages. A few older endpoints still answer
    with `error` alone.
servers:
  - url: https://api.onetsolutions.net
    description: Production
security: []
tags:
  - name: Authentication
    description: >-
      Login, passwordless authentication, MFA, OAuth providers, and token
      management.
  - name: Organizations
    description: >-
      Organization management, members, roles, modules, audit logs, and
      notification settings.
  - name: Projects
    description: Project management, team members, and project-scoped resources.
  - name: Compute
    description: >-
      Cloud instances, volumes, snapshots, backups, VPCs, firewalls, SSH keys,
      uptime monitors, and instance tasks.
  - name: Billing
    description: >-
      Shopping cart, orders, invoices, payments, payment methods, gateways,
      promo codes, and balance management.
  - name: Domains
    description: >-
      Domain availability, registration, transfers, DNS zones, DNS records, and
      TLD information.
  - name: Web Hosting
    description: >-
      cPanel-based web hosting, emails, databases, subdomains, FTP accounts,
      addon domains, and SSL certificates.
paths:
  /v1/organizations/{organization_id}/projects/{project_id}/integrations/cloudflare:
    get:
      tags:
        - Domains
      summary: '[Cloudflare] Retrieve the connected Cloudflare account'
      description: >-
        Return the Cloudflare account connected to this project, or `connection:
        null` when none is. Tokens are never returned. `connected_by` is only
        shown to the organization's owners: it is null for other members,
        project guests and project-scoped API keys.
      operationId: retrieve_cloudflare_connection
      parameters:
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          required: true
        - in: path
          name: project_id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudflareConnectionEnvelope'
          description: ''
        '401':
          description: Authentication credentials were not provided or are invalid
        '403':
          description: You do not have permission to perform this action
        '404':
          description: >-
            Organization or project not found (code: project_not_found), or the
            project is outside the caller's reach
        '503':
          description: >-
            The Cloudflare integration is not offered (code:
            cloudflare_integration_disabled), or is temporarily unavailable
            (code: cloudflare_integration_unavailable)
      security:
        - BearerAuth: []
components:
  schemas:
    CloudflareConnectionEnvelope:
      type: object
      properties:
        connection:
          allOf:
            - $ref: '#/components/schemas/CloudflareConnection'
          nullable: true
      required:
        - connection
    CloudflareConnection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        status:
          enum:
            - active
            - needs_reauth
          type: string
          description: |-
            * `active` - active
            * `needs_reauth` - needs reauth
          x-spec-enum-id: e943bec49240c231
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/CloudflareAccount'
        granted_scopes:
          type: array
          items:
            type: string
        missing_optional_scopes:
          type: array
          items:
            type: string
          readOnly: true
        connected_by:
          allOf:
            - $ref: '#/components/schemas/CloudflareConnectedBy'
          nullable: true
        created:
          type: string
          format: date-time
          readOnly: true
        modified:
          type: string
          format: date-time
          readOnly: true
        linked_zone_count:
          type: integer
          readOnly: true
      required:
        - accounts
        - connected_by
        - created
        - granted_scopes
        - id
        - linked_zone_count
        - missing_optional_scopes
        - modified
        - status
    CloudflareAccount:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
    CloudflareConnectedBy:
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
      required:
        - email
        - id
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use `Authorization: Bearer <token>` header. Token can be a JWT token or
        an API key (format: `sk-onetsolutions-...`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.