> ## 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.

# Ask for the organization's data to be erased

> Registers the request with the retention plan as it was shown, sends the acknowledgement that states the one-month deadline, and puts the request in the staff review queue.



## OpenAPI

````yaml https://api.onetsolutions.net/schema post /v1/organizations/{organization_id}/privacy/erasure-request
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}/privacy/erasure-request:
    post:
      tags:
        - Privacy
      summary: Ask for the organization's data to be erased
      description: >-
        Registers the request with the retention plan as it was shown, sends the
        acknowledgement that states the one-month deadline, and puts the request
        in the staff review queue.
      operationId: create_erasure_request
      parameters:
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateErasureRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErasureRequest'
          description: ''
        '409':
          description: >-
            A request is already open, or a service, an unpaid invoice or an
            open abuse report blocks it
      security:
        - BearerAuth: []
components:
  schemas:
    CreateErasureRequest:
      type: object
      properties:
        message:
          type: string
          default: ''
          maxLength: 2000
    ErasureRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          enum:
            - pending
            - approved
            - executed
            - refused
            - cancelled
          type: string
          description: |-
            * `pending` - Awaiting review
            * `approved` - Approved, erasure running
            * `executed` - Executed
            * `refused` - Refused
            * `cancelled` - Cancelled by the customer
          x-spec-enum-id: 09b9dbcf74653554
        created:
          type: string
          format: date-time
        respond_by:
          type: string
          format: date
        decided_at:
          type: string
          format: date-time
          nullable: true
        decision_note:
          type: string
        plan:
          $ref: '#/components/schemas/RetentionPlan'
        outcome: {}
      required:
        - created
        - decided_at
        - decision_note
        - id
        - outcome
        - plan
        - respond_by
        - status
    RetentionPlan:
      type: object
      properties:
        relationship_end:
          type: string
          format: date
          nullable: true
        respond_by:
          type: string
          format: date
        erasable:
          type: array
          items:
            $ref: '#/components/schemas/ErasableEntry'
        retained:
          type: array
          items:
            $ref: '#/components/schemas/RetainedEntry'
        blockers:
          type: array
          items:
            enum:
              - active_service
              - unpaid_invoice
              - open_abuse_report
            type: string
            description: |-
              * `active_service` - A service is still running
              * `unpaid_invoice` - An invoice attached to a service is unpaid
              * `open_abuse_report` - An abuse report is still open
            x-spec-enum-id: e22c4afffa81a0f5
      required:
        - blockers
        - erasable
        - relationship_end
        - respond_by
        - retained
    ErasableEntry:
      type: object
      properties:
        category:
          enum:
            - prospection
            - carts
            - feedback
            - sessions
            - preferences
            - legacy_activity_log
          type: string
          description: |-
            * `prospection` - Commercial prospection
            * `carts` - Abandoned carts
            * `feedback` - Product feedback
            * `sessions` - Sessions and authentication factors
            * `preferences` - Console preferences
            * `legacy_activity_log` - Legacy activity log beyond its retention
          x-spec-enum-id: 2660071777f3ac70
        count:
          type: integer
      required:
        - category
        - count
    RetainedEntry:
      type: object
      properties:
        category:
          enum:
            - accounting
            - hosting_identity
            - contracts
            - support
            - connection_logs
            - abuse
          type: string
          description: |-
            * `accounting` - Accounting records
            * `hosting_identity` - Hosting provider identification data
            * `contracts` - Contracts, orders and services
            * `support` - Support tickets
            * `connection_logs` - Console connection logs
            * `abuse` - Abuse reports
          x-spec-enum-id: 947b46deeb99ef24
        reference:
          type: string
        until:
          type: string
          format: date
      required:
        - category
        - reference
        - until
  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.