Spectro Cloud tenants API

The tenants API from Spectro Cloud — 51 operation(s) for tenants.

Operations 80

GET /v1/tenants Retrieves a list of tenants #
POST /v1/tenants Creates a tenant #
POST /v1/tenants/marketplace/aws/setup Validates the AWS Marketplace token and redirects the browser to the UI setup page #
POST /v1/tenants/marketplace/register Registers a marketplace user by resolving the registration token, verifying entitlements, and provisioning a tenant #
POST /v1/tenants/signup Self signing up #
POST /v1/tenants/signup/{signupToken}/activate Activates the self signed tenant using the password token #
POST /v1/tenants/validate Validate tenant #
DELETE /v1/tenants/{tenantUid} Deletes the specified tenant #
GET /v1/tenants/{tenantUid} Returns the specified tenant #
PATCH /v1/tenants/{tenantUid}/activate activates the specified tenant #
PATCH /v1/tenants/{tenantUid}/address Update tenant address #
GET /v1/tenants/{tenantUid}/assets/certs lists the certificates for the tenant #
POST /v1/tenants/{tenantUid}/assets/certs create the tenant certificate #
DELETE /v1/tenants/{tenantUid}/assets/certs/{certificateUid} deletes the tenant certificate #
GET /v1/tenants/{tenantUid}/assets/certs/{certificateUid} Returns the ca certificate for the tenant #
PUT /v1/tenants/{tenantUid}/assets/certs/{certificateUid} updates the tenant certificate #
DELETE /v1/tenants/{tenantUid}/assets/dataSinks deletes the tenant data sink config #
GET /v1/tenants/{tenantUid}/assets/dataSinks Returns data sink config of tenant #
POST /v1/tenants/{tenantUid}/assets/dataSinks create data sink config #
PUT /v1/tenants/{tenantUid}/assets/dataSinks updates the tenant data sink config #
GET /v1/tenants/{tenantUid}/authTokenSettings Get tenant auth token settings #
PUT /v1/tenants/{tenantUid}/authTokenSettings Update tenant auth token settings #
DELETE /v1/tenants/{tenantUid}/cleanUp Clean up tenant resources #
PUT /v1/tenants/{tenantUid}/contract Updates the tenant contract settings #
PATCH /v1/tenants/{tenantUid}/contract/accept Tenant to accept the contract agreement #
DELETE /v1/tenants/{tenantUid}/creditAccount/aws Deletes the aws credit account for tenants #
GET /v1/tenants/{tenantUid}/creditAccount/aws Get the credit accounts for the tenants with free tier access #
POST /v1/tenants/{tenantUid}/datasinks/splunk Creates the Splunk HEC data sink for the specified tenant #
POST /v1/tenants/{tenantUid}/datasinks/splunk/validate Validates the Splunk HEC data sink connection for the specified tenant #
DELETE /v1/tenants/{tenantUid}/datasinks/splunk/{uid} Deletes the Splunk HEC data sink for the specified tenant #
GET /v1/tenants/{tenantUid}/datasinks/splunk/{uid} Returns the Splunk HEC data sink for the specified tenant #
PUT /v1/tenants/{tenantUid}/datasinks/splunk/{uid} Updates the Splunk HEC data sink for the specified tenant #
GET /v1/tenants/{tenantUid}/datasinks/summary Returns a summary of all data sinks configured for the specified tenant #
GET /v1/tenants/{tenantUid}/domains retrieves the domains for tenant #
POST /v1/tenants/{tenantUid}/domains creates or updates domains for tenant #
PATCH /v1/tenants/{tenantUid}/emailId Update tenant emailId #
GET /v1/tenants/{tenantUid}/freemium Get tenant level freemium configuration #
PUT /v1/tenants/{tenantUid}/freemium Update tenant freemium configuration #
GET /v1/tenants/{tenantUid}/freemiumUsage Get tenant freemium usage #
GET /v1/tenants/{tenantUid}/idp/palette/config Returns the Palette IDP config for the tenant #
GET /v1/tenants/{tenantUid}/invoices/{invoiceUid} Returns a specified invoice #
GET /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/invoice/pdf Downloads the specified invoice report #
GET /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/pdf Downloads the specified monthly invoice report #
GET /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/usage/pdf Downloads the specified tenant usage #
GET /v1/tenants/{tenantUid}/isCleanedUp Get cleaned up tenant resources #
GET /v1/tenants/{tenantUid}/loginBanner Get tenant login banner settings #
PUT /v1/tenants/{tenantUid}/loginBanner Update tenant login banner settings #
DELETE /v1/tenants/{tenantUid}/macros Delete the macros for the specified tenant by given macro name #
GET /v1/tenants/{tenantUid}/macros List the macros of the specified tenant #
PATCH /v1/tenants/{tenantUid}/macros Update the macros for the specified tenant by given macro name #
POST /v1/tenants/{tenantUid}/macros Create or add new macros for the specified tenant #
PUT /v1/tenants/{tenantUid}/macros Update the macros of the specified tenant #
GET /v1/tenants/{tenantUid}/oidc/config Returns the oidc Spec for tenant #
POST /v1/tenants/{tenantUid}/oidc/config Associates the oidc Spec for the tenant #
GET /v1/tenants/{tenantUid}/password/policy retrieves the password policy for tenant #
POST /v1/tenants/{tenantUid}/password/policy creates or updates a password policy for tenant #
GET /v1/tenants/{tenantUid}/plan Returns the current tenant's plan #
GET /v1/tenants/{tenantUid}/plans/usage/monthly Returns the tenant's monthly planUsage grouped by projects #
GET /v1/tenants/{tenantUid}/preferences/clusterGroup Get is cluster group enabled for a specific tenant #
PUT /v1/tenants/{tenantUid}/preferences/clusterGroup Enable or Disable cluster group for a specific tenant #
GET /v1/tenants/{tenantUid}/preferences/clusterRbacSettings Get tenant cluster RBAC settings #
PUT /v1/tenants/{tenantUid}/preferences/clusterRbacSettings Update tenant cluster RBAC settings #
GET /v1/tenants/{tenantUid}/preferences/clusterSettings Get tenant cluster settings #
PUT /v1/tenants/{tenantUid}/preferences/clusterSettings/nodesAutoRemediationSetting Update tenant clusters nodes auto remediation setting #
GET /v1/tenants/{tenantUid}/preferences/developerCredit Get developer credit enabled for a specific tenant #
PUT /v1/tenants/{tenantUid}/preferences/developerCredit update developer credit for a specific tenant #
GET /v1/tenants/{tenantUid}/preferences/fips Get tenant fips settings #
PUT /v1/tenants/{tenantUid}/preferences/fips Update tenant fips setting #
GET /v1/tenants/{tenantUid}/rateConfig Get all rate config for public and private cloud #
PUT /v1/tenants/{tenantUid}/rateConfig updates the rate config for public and private cloud #
GET /v1/tenants/{tenantUid}/resourceLimits Get tenant level resource limits configuration #
PATCH /v1/tenants/{tenantUid}/resourceLimits Update tenant resource limits configuration #
GET /v1/tenants/{tenantUid}/saml/config Returns the specified service provider metadata and Saml Spec for tenant #
POST /v1/tenants/{tenantUid}/saml/config Associates the specified federation metadata for the tenant #
GET /v1/tenants/{tenantUid}/sso/auth/providers get sso logins for the tenants #
POST /v1/tenants/{tenantUid}/sso/auth/providers enable sso logins for the tenants #
GET /v1/tenants/{tenantUid}/subscriptions/aws/{uid} Returns the details of a specific AWS marketplace subscription #
GET /v1/tenants/{tenantUid}/subscriptions/metadata Returns the metadata of marketplace subscriptions for the tenant #
GET /v1/tenants/{tenantUid}/usage/cpuCoreHours Returns the tenant's cpu corehours usages grouped by projects #
GET /v1/tenants/{tenantUid}/user Returns the user object of the specified tenant #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/spectro-cloud-tenants-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spectro-cloud-tenants-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Local Management APIs activations Tenants API
  version: v1
servers:
- url: https://edge-host-ip:5080
tags:
- name: tenants
  x-displayName: Tenants
paths:
  /v1/tenants:
    get:
      operationId: v1TenantsList
      parameters:
      - description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
        in: query
        name: fields
        schema:
          type: string
      - description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws


          Server will be restricted to certain fields based on the indexed data for each resource.'
        in: query
        name: filters
        schema:
          type: string
      - description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
        in: query
        name: orderBy
        schema:
          type: string
      - description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.

          If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
        in: query
        name: limit
        schema:
          type: integer
          format: int64
          default: 50
      - description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
        in: query
        name: offset
        schema:
          type: integer
          format: int64
      - description: continue token to paginate the subsequent data items
        in: query
        name: continue
        schema:
          type: string
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '200':
          description: An array of tenants
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Tenants'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of tenants
      tags:
      - tenants
    post:
      operationId: v1TenantsCreate
      parameters:
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates a tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantEntity'
  /v1/tenants/marketplace/aws/setup:
    post:
      operationId: v1MarketplaceAwsSetup
      responses:
        '303':
          description: Redirects to the UI setup page with an encrypted token
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validates the AWS Marketplace token and redirects the browser to the UI setup page
      tags:
      - tenants
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                x-amzn-marketplace-token:
                  type: string
                  description: Temporary registration token from AWS Marketplace
              required:
              - x-amzn-marketplace-token
  /v1/tenants/marketplace/register:
    post:
      description: 'Called after a user completes a SaaS contract purchase on a marketplace (e.g., AWS Marketplace) and is redirected to the Palette registration landing page. The flow resolves the temporary registration token to obtain the user''s account identifier and product code, fetches the user''s entitlements and creates a new tenant with the corresponding plan and admin user. The registration token is short-lived and must be resolved promptly.

        '
      operationId: v1MarketplaceRegister
      responses:
        '201':
          description: Registration completed — tenant provisioned, entitlements applied to plan
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1MarketplaceRegisterResponse'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Registers a marketplace user by resolving the registration token, verifying entitlements, and provisioning a tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1MarketplaceRegisterEntity'
  /v1/tenants/signup:
    post:
      operationId: v1TenantsSelfSignUp
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Self signing up
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantSelfSignUpSpec'
  /v1/tenants/signup/{signupToken}/activate:
    parameters:
    - in: path
      name: signupToken
      required: true
      schema:
        type: string
    post:
      operationId: v1TenantsSelfSignUpActivate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Activates the self signed tenant using the password token
      tags:
      - tenants
  /v1/tenants/validate:
    post:
      operationId: v1TenantsValidate
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validate tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantBasicEntity'
  /v1/tenants/{tenantUid}:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    delete:
      operationId: v1TenantsDelete
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the specified tenant
      tags:
      - tenants
    get:
      operationId: v1TenantsGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Tenant'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/activate:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    patch:
      operationId: V1TenantsUidActivate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: activates the specified tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantActivate'
  /v1/tenants/{tenantUid}/address:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    patch:
      operationId: v1PatchTenantAddress
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant address
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantAddressPatch'
  /v1/tenants/{tenantUid}/assets/certs:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: V1TenantUIdAssetsCertsList
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantAssetCerts'
      security:
      - ApiKey: []
      - Authorization: []
      summary: lists the certificates for the tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidAssetsCertsCreate
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the tenant certificate
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantAssetCert'
  /v1/tenants/{tenantUid}/assets/certs/{certificateUid}:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - in: path
      name: certificateUid
      required: true
      schema:
        type: string
    delete:
      operationId: V1TenantUidAssetsCertsUidDelete
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: deletes the tenant certificate
      tags:
      - tenants
    get:
      operationId: V1TenantUidAssetsCertsUidGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantAssetCert'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the ca certificate for the tenant
      tags:
      - tenants
    put:
      operationId: V1TenantUidAssetsCertsUidUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: updates the tenant certificate
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantAssetCert'
  /v1/tenants/{tenantUid}/assets/dataSinks:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    delete:
      operationId: V1TenantUidAssetsDataSinksDelete
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: deletes the tenant data sink config
      tags:
      - tenants
    get:
      operationId: V1TenantUidAssetsDataSinksGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1DataSinkConfig'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns data sink config of tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidAssetsDataSinksCreate
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create data sink config
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1DataSinkConfig'
    put:
      operationId: V1TenantUidAssetsDataSinksUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: updates the tenant data sink config
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1DataSinkConfig'
  /v1/tenants/{tenantUid}/authTokenSettings:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: v1TenantUidAuthTokenSettingsGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1AuthTokenSettings'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant auth token settings
      tags:
      - tenants
    put:
      operationId: v1TenantUidAuthTokenSettingsUpdate
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant auth token settings
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1AuthTokenSettings'
  /v1/tenants/{tenantUid}/cleanUp:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - in: query
      name: useTenantCtx
      schema:
        type: boolean
    - in: query
      name: forceDelete
      schema:
        type: boolean
    delete:
      operationId: v1TenantsCleanUp
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Clean up tenant resources
      tags:
      - tenants
  /v1/tenants/{tenantUid}/contract:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    put:
      operationId: v1TenantsUidContractUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the tenant contract settings
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantContractSpec'
  /v1/tenants/{tenantUid}/contract/accept:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    patch:
      operationId: v1TenantsUidContractAccept
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Tenant to accept the contract agreement
      tags:
      - tenants
  /v1/tenants/{tenantUid}/creditAccount/aws:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    delete:
      operationId: v1TenantsCreditAccountDelete
      parameters:
      - in: query
        name: forceDelete
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the aws credit account for tenants
      tags:
      - tenants
    get:
      operationId: v1TenantsCreditAccountGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1AwsCreditAccountEntity'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get the credit accounts for the tenants with free tier access
      tags:
      - tenants
  /v1/tenants/{tenantUid}/datasinks/splunk:
    post:
      operationId: V1TenantUidDatasinksSplunkCreate
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Uid'
        '400':
          description: Invalid request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '409':
          description: Sink already exists for tenant + kind (runtime code=SinkAlreadyExists)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1SplunkSinkEntity'
        required: true
  /v1/tenants/{tenantUid}/datasinks/splunk/validate:
    post:
      operationId: V1TenantUidDatasinksSplunkValidate
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
        '400':
          description: Invalid request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '504':
          description: Network/TLS/timeout error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validates the Splunk HEC data sink connection for the specified tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1SplunkSinkSpec'
        required: true
  /v1/tenants/{tenantUid}/datasinks/splunk/{uid}:
    delete:
      operationId: V1TenantUidDatasinksSplunkDelete
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      - in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The resource was deleted successfully
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
    get:
      operationId: V1TenantUidDatasinksSplunkGet
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      - in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1SplunkSink'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
    put:
      operationId: V1TenantUidDatasinksSplunkUpdate
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      - in: path
        name: uid
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              schema:
                type: string
        '400':
          description: Invalid request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1SplunkSinkEntity'
        required: true
  /v1/tenants/{tenantUid}/datasinks/summary:
    get:
      operationId: V1TenantUidDatasinksSummaryGet
      parameters:
      - in: path
        name: tenantUid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1DataSinksSummary'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns a summary of all data sinks configured for the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/domains:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: V1TenantUidDomainsGet
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantDomains'
      security:
      - ApiKey: []
      - Authorization: []
      summary: retrieves the domains for tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidDomainsUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: creates or updates domains for tenant
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantDomains'
  /v1/tenants/{tenantUid}/emailId:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    patch:
      operationId: v1PatchTenantEmailId
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant emailId
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantEmailPatch'
  /v1/tenants/{tenantUid}/freemium:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: v1TenantFreemiumGet
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantFreemium'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant level freemium configuration
      tags:
      - tenants
    put:
      operationId: v1TenantFreemiumUpdate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant freemium configuration
      tags:
      - tenants
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1TenantFreemium'
  /v1/tenants/{tenantUid}/freemiumUsage:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: v1TenantFreemiumUsageGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantFreemiumUsage'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant freemium usage
      tags:
      - tenants
  /v1/tenants/{tenantUid}/idp/palette/config:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: V1TenantUidIdpPaletteConfigGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1TenantPaletteIdpConfigSpec'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the Palette IDP config for the tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      schema:
        type: string
    get:
      operationId: v1InvoicesUidGet
      responses:
        '200':
          description: (empty)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Invoice'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns a specified invoice
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/invoice/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      schema:
        type: string
    get:
      operationId: V1InvoiceUidReportInvoicePdf
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              schema:
                type: string
            Content-Type:
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified invoice report
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      schema:
        type: string
    get:
      operationId: V1InvoiceUidReportPdf
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              schema:
                type: string
            Content-Type:
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified monthly invoice report
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/usage/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      schema:
        type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      schema:
        type: string
    get:
      operationId: V1InvoiceUidReportUsagePdf
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              schema:
                type: string
            Content-Type:
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified tenant usage
      tags:
      - tenants
  /v1/tenants/{tenantUid}/isCleanedUp:
    parameters:
    - in: path
      name: tenantUid
      required: true
      schema:
        type: string
    get:
      operationId: v1TenantsIsCleanedUp
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
         

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-tenants-api-openapi.yml