CDC simulator API is one of 14 APIs that CDC publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include simulator. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
3 operations
across 3 paths,
and defines 11 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against the base URL https://data.cdc.gov/resource.
3 operations3 paths11 schemas1 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://data.cdc.gov/resource
Resource Areas
1
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
simulator 3
POST
/api/v1/simulator/discover-configurations
Discover Configurations
discoverConfigurationsbody→ 200422
POST
/api/v1/simulator/upload
Simulator Upload
uploadEcrbody→ 200422
GET
/api/v1/simulator/download/{filename}
Download Refined Ecr
downloadRefinedEcr1 param→ 200422
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SimulatorUploadResponse (6 properties), Condition (5 properties), ValidationError (5 properties), DiscoveredConfigurationVersion (3 properties). Each schema is shown below with its type and property counts.
Body_uploadEcr
object
2 properties1 required
DiscoveredConfigurationsResponse
object
Model to represent the sets of discovered configurations to return to the client.
1 property1 required
ValidationError
object
5 properties3 required
HTTPValidationError
object
1 property
Condition
object
Model for a Condition.
5 properties5 required
DiscoveredConfigurationSet
object
Model to represent a set of discovered configurations.
3 properties3 required
FileInfoResponse
object
Utility class to help Orval ship these values to the frontend.
2 properties
Body_discoverConfigurations
object
1 property
DbConfigurationStatus
string
DiscoveredConfigurationVersion
object
Model to represent individual discovered configurations.
3 properties3 required
SimulatorUploadResponse
object
Model for the response when uploading a document in the simulate testing suite.
6 properties6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
