Bureau of Consular Affairs · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Bureau of Consular Affairs write-api

3 actions 3 updates update extends openapi/bureau-of-consular-affairs-write-api-openapi.yml

Derived by API Evangelist Built from the contracts Bureau of Consular Affairs publishes. Bureau of Consular Affairs did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-reversibilityx-apievangelist-providerx-apievangelist-surfacex-apievangelist-artifactsx-apievangelist-warningx-apievangelist-idempotencyx-apievangelist-host-access

Targets 3

$.info

$.paths['/action/package_delete'].post

$.paths['/action/package_update'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Bureau of Consular Affairs write-api
  version: 1.0.0
extends: openapi/bureau-of-consular-affairs-write-api-openapi.yml
x-provenance:
  generated: '2026-09-05'
  method: generated
  source: openapi/bureau-of-consular-affairs-write-api-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: bureau-of-consular-affairs
      x-apievangelist-surface: CKAN Action API on the CA Data Catalog
      x-apievangelist-artifacts:
        authentication: authentication/bureau-of-consular-affairs-authentication.yml
        conventions: conventions/bureau-of-consular-affairs-conventions.yml
        errors: errors/bureau-of-consular-affairs-problem-types.yml
        data_model: data-model/bureau-of-consular-affairs-data-model.yml
        conformance: conformance/bureau-of-consular-affairs-conformance.yml
        lifecycle: lifecycle/bureau-of-consular-affairs-lifecycle.yml
      x-apievangelist-warning: >-
        This API returns HTTP 200 on failure. Read the "success" boolean in the response body; the
        status code is not the signal. See the error catalog artifact.
      x-apievangelist-idempotency: none
      x-apievangelist-host-access: >-
        cadatacatalog.state.gov is fronted by a Cloudflare WAF that returned 403 to every automated
        request from this pipeline on 2026-09-05. The operations described here are documented, not
        observed against the live host.
  - target: $.paths['/action/package_delete'].post
    update:
      x-apievangelist-reversibility:
        grade: documented
        reversal: packageUpdate
        detail: >-
          CKAN package_delete is a soft delete that sets state to "deleted"; a sysadmin can restore
          the dataset by setting state back to "active". No retention window is published.
        window: null
  - target: $.paths['/action/package_update'].post
    update:
      x-apievangelist-reversibility:
        grade: none
        detail: No undo. The previous dataset document is not returned and no revision-restore action is exposed.

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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 overlay

curl "https://apis.io/api/v1/overlays/bureau-of-consular-affairs-write-api-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.