Acceldata

Acceldata Rule Configuration API

The Rule Configuration API from Acceldata — 2 operation(s) for rule configuration.

GitHub OpenAPI

Operations 2

GET /catalog-server/api/rules/{id}/configuration Get rule persistence configuration #
GET /catalog-server/api/rules/byName/{name}/configuration Get rule persistence configuration by name #

Documentation

📖
Documentation
https://docs.acceldata.io/api/introduction
📖
APIReference
https://documentation.acceldata.io/docs/acceldata/api/catalog
📖
Authentication
https://docs.acceldata.io/api/authentication
📖
Documentation
https://docs.acceldata.io/documentation/roles-and-permissions
📖
APIReference
https://documentation.acceldata.io/docs/acceldata/api/administration
📖
Authentication
https://docs.acceldata.io/documentation/api-keys
📖
Documentation
https://docs.acceldata.io/documentation/unified-tags
📖
APIReference
https://documentation.acceldata.io/docs/acceldata/api/tags

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/openapi/acceldata-rule-configuration-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/data-model/acceldata-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/errors/acceldata-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/conventions/acceldata-conventions.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/scopes/acceldata-scopes.yml

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/acceldata-rule-configuration-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.

GitHub Google LinkedIn

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

OpenAPI Specification

acceldata-rule-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Catalog Rule Configuration API
  version: '1.0'
  description: API for managing the ADOC data catalog, including assets, asset metadata, tags, labels, sampling, lineage, and watched assets, as well as data reliability policies (data quality, reconciliation, data drift, schema drift, and related rule types) and their executions. Covers discovering and searching assets, retrieving asset configuration and activity, and creating, scheduling, and running policies against catalog assets.
tags:
- name: Rule Configuration
paths:
  /catalog-server/api/rules/{id}/configuration:
    get:
      operationId: getRuleConfiguration
      tags:
      - Rule Configuration
      summary: Get rule persistence configuration
      description: 'This endpoint is used to fetch the storage location for Data Quality policy results and summaries based on the policy ID.


        **Authorization**: requires `ASSET_VIEW` and `POLICY_VIEW`.'
      parameters:
      - name: id
        in: path
        description: Numeric policy/rule ID
        required: true
        schema:
          type: integer
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Rule configuration details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleConfig'
        '400':
          description: Bad Request — missing or non-numeric id
  /catalog-server/api/rules/byName/{name}/configuration:
    get:
      operationId: getRuleConfigurationByName
      tags:
      - Rule Configuration
      summary: Get rule persistence configuration by name
      description: 'This endpoint retrieves the storage location for Data Quality policy results and summaries based on the policy name.


        **Authorization**: requires `ASSET_VIEW` and `POLICY_VIEW`.'
      parameters:
      - name: name
        in: path
        description: Policy name
        required: true
        schema:
          type: string
      - name: accessKey
        in: header
        description: API access key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: secretKey
        in: header
        description: API secret key generated from ADOC UI
        required: true
        schema:
          type: string
      - name: Accept
        in: header
        description: Always set to application/json
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Rule configuration details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleConfig'
        '404':
          description: 'Rule with the given name: {name} not found'
components:
  schemas:
    SingleCategoryPersistenceConfig:
      type: object
      title: io.ad.catalog.api.model.SingleCategoryPersistenceConfig
      required:
      - format
      - suffixTemplate
      properties:
        format:
          type: string
          enum:
          - PARQUET
          - ORC
          - CSV
          - JSON
        suffixTemplate:
          type: string
    SingleCategoryResultHandlingConfig:
      type: object
      title: io.ad.catalog.api.model.SingleCategoryResultHandlingConfig
      required:
      - sampleOnly
      - storeResult
      properties:
        sampleOnly:
          type: boolean
        storeResult:
          type: boolean
    DefaultPolicyPersistencePathConfig:
      type: object
      title: io.ad.catalog.api.model.DefaultPolicyPersistencePathConfig
    RuleConfig:
      type: object
      title: io.ad.catalog.api.model.quality.RuleConfig
      required:
      - ruleId
      properties:
        categoriesPersistenceConfig:
          $ref: '#/components/schemas/PolicyPersistencePathConfig'
        categoriesResultHandlingConfig:
          oneOf:
          - $ref: '#/components/schemas/CategoriesResultHandlingConfig'
          - type: 'null'
        id:
          type: integer
        persistenceFolderPrefix:
          type:
          - string
          - 'null'
        ruleId:
          type: integer
    CustomPolicyPersistencePathConfig:
      type: object
      title: io.ad.catalog.api.model.CustomPolicyPersistencePathConfig
      required:
      - categoriesConfig
      properties:
        categoriesConfig:
          $ref: '#/components/schemas/CategoriesPersistenceConfig'
    PolicyPersistencePathConfig:
      type:
      - object
      - 'null'
      title: io.ad.catalog.api.model.PolicyPersistencePathConfig
      oneOf:
      - $ref: '#/components/schemas/CustomPolicyPersistencePathConfig'
      - $ref: '#/components/schemas/DefaultPolicyPersistencePathConfig'
      - $ref: '#/components/schemas/SavedPolicyPersistencePathConfig'
      discriminator:
        propertyName: type
        mapping:
          io.ad.catalog.api.model.CustomPolicyPersistencePathConfig: '#/components/schemas/CustomPolicyPersistencePathConfig'
          io.ad.catalog.api.model.DefaultPolicyPersistencePathConfig: '#/components/schemas/DefaultPolicyPersistencePathConfig'
          io.ad.catalog.api.model.SavedPolicyPersistencePathConfig: '#/components/schemas/SavedPolicyPersistencePathConfig'
    CategoriesPersistenceConfig:
      type: object
      title: io.ad.catalog.api.model.CategoriesPersistenceConfig
      required:
      - bad
      - good
      properties:
        bad:
          $ref: '#/components/schemas/SingleCategoryPersistenceConfig'
        good:
          $ref: '#/components/schemas/SingleCategoryPersistenceConfig'
        metadata:
          oneOf:
          - $ref: '#/components/schemas/MetadataPersistenceConfig'
          - type: 'null'
    CategoriesResultHandlingConfig:
      type: object
      title: io.ad.catalog.api.model.CategoriesResultHandlingConfig
      required:
      - bad
      - good
      properties:
        bad:
          $ref: '#/components/schemas/SingleCategoryResultHandlingConfig'
        good:
          $ref: '#/components/schemas/SingleCategoryResultHandlingConfig'
    SavedPolicyPersistencePathConfig:
      type: object
      title: io.ad.catalog.api.model.SavedPolicyPersistencePathConfig
      required:
      - configId
      properties:
        configId:
          type: integer
    MetadataPersistenceConfig:
      type: object
      title: io.ad.catalog.api.model.MetadataPersistenceConfig
      required:
      - suffixTemplate
      properties:
        suffixTemplate:
          type: string