Arcadia Deletion API

openapi: 3.2.0
info:
  description: Plug API
  title: Plug Deletion API
  version: 2.0.0
servers:
- url: https://api.arcadia.com
security:
- OAuth2: []
tags:
- name: Deletion
paths:
  /apiKeys/{clientId}:
    delete:
      description: Permanently deletes an API key, revoking its ability to authenticate.
      operationId: delete-api-key
      parameters:
      - in: path
        name: clientId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          description: OK
      summary: Delete API Key
      tags:
      - Deletion
  /businessUnits/{businessUnitId}:
    delete:
      description: Deletes a Business Unit. Any accounts assigned to it are moved to the Business Unit specified by `moveAccountsToBusinessUnitId`, or to its parent if that parameter is omitted.
      operationId: delete-business-unit
      parameters:
      - in: path
        name: businessUnitId
        required: true
        schema:
          type: string
      - description: The Business Unit to move the deleted Business Unit's accounts to. Defaults to the deleted Business Unit's parent if omitted.
        in: query
        name: moveAccountsToBusinessUnitId
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          description: OK
      summary: Delete Business Unit
      tags:
      - Deletion
  /plug/credentials/{credentialId}/resources:
    delete:
      description: 'Use this endpoint to delete a Credential from the system. Once completed, this Credential and its associated Accounts, Meters, and Statements resources will be deleted and cannot be recovered. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call this endpoint.


        This endpoint supports Sandbox Mode.'
      operationId: delete-credential-along-with-its-accounts-meters-and-statements-resources
      parameters:
      - in: path
        name: credentialId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDeletionLogResource'
          description: OK
      summary: Delete Credential Along With its Accounts, Meters, and Statements Resources
      tags:
      - Deletion
      servers:
      - url: https://api.arcadia.com
      - url: https://sandbox.api.arcadia.com
  /plug/deletionLogs/{deletionLogId}:
    get:
      description: This endpoint allows you to view the details of a particular deletion request, after performing the deletion.
      operationId: retrieve-deletion-log
      parameters:
      - in: path
        name: deletionLogId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDeletionLogResource'
          description: OK
      summary: Retrieve Deletion Log
      tags:
      - Deletion
  /plug/files/{fileId}/resources:
    delete:
      description: Once completed, this File and its associated Accounts, Meters, and Statements resources will be deleted and cannot be recovered. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call this endpoint.
      operationId: deletes-file-along-with-its-accounts-meters-and-statements-resources
      parameters:
      - in: path
        name: fileId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDeletionLogResource'
          description: OK
      summary: Deletes File Along With its Accounts, Meters, and Statements Resources
      tags:
      - Deletion
  /plug/sites/{siteId}:
    delete:
      description: 'Unlike Credential and File deletions, Site deletion does not delete any related entities, but it does remove references to the deleted Site on those related entities. For example, Meters assigned to the site will be unassigned when the Site is deleted. After completion, you can check the status of deletion by using the Deletion Log ID from the response body and call this endpoint.


        This endpoint supports Sandbox Mode.'
      operationId: delete-site
      parameters:
      - in: path
        name: siteId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/arcVersionInHeaderParam'
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PublicDeletionLogResource'
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDeletionLogResource'
          description: OK
      summary: Delete Site
      tags:
      - Deletion
      servers:
      - url: https://api.arcadia.com
      - url: https://sandbox.api.arcadia.com
components:
  schemas:
    PublicDeletionLogResource:
      type: object
      properties:
        accountCount:
          type: integer
          format: int32
          description: 'The number of accounts. Note: if this is 0, but the entity being deleted has associated accounts, those accounts will be unlinked from the deleted entity but remain in the system. This is because the accounts are associated with another file or credential that is not being deleted.'
        createdAt:
          type: string
          format: date-time
          description: A timestamp indicating when the entity was created.
        createdBy:
          type:
          - string
          - 'null'
          description: User or system responsible for creating the entity.
        deletionTargetId:
          type: string
          description: The ID of the primary resource being deleted. May belong to an Account, Credential, File or Site.
        fileCount:
          type: integer
          format: int32
          description: The total number of files that are requested to be deleted.
        id:
          type: string
          description: A unique identifier for the entity.
        meterCount:
          type: integer
          format: int32
          description: The total number of meters associated with the account.
        siteCount:
          type: integer
          format: int32
          description: The total number of Sites.
        statementCount:
          type: integer
          format: int32
          description: The total number of statements.
        status:
          type: string
          description: Status of the resource.
          enum:
          - REQUESTED
          - SCHEDULED
          - SUCCESS
          - FAILURE
      required:
      - accountCount
      - createdAt
      - createdBy
      - deletionTargetId
      - fileCount
      - id
      - meterCount
      - siteCount
      - statementCount
      - status
  parameters:
    arcVersionInHeaderParam:
      name: Arcadia-Version
      in: header
      example: '2024-02-21'
      description: The Arcadia-Version for the request
      required: true
      schema:
        type: string
        default: '2024-02-21'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth2 with the client credentials flow using the ['Create an Access Token'](ref:create-access-token) endpoint. API keys can be retrieved from the [Dashboard](https://dashboard.arcadia.com/).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth2/token
x-provenance:
  method: harvested
  publisher: Arcadia
  source: https://docs.arcadia.com/openapi/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)