Eon resources API is one of 13 APIs that Eon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include resources. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
12 operations
across 9 paths,
and defines 50 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, /.
12 operations9 paths50 schemas2 DELETE2 GET7 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://console.eon.io
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Eon resources API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 12
Across 9 paths, the API surfaces 12 operations — 2 DELETE, 2 GET, 7 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are InventoryResource (20 properties), InventoryFilterConditions (13 properties), InventoryVolume (8 properties), ResourceNameFilters (4 properties). Each schema is shown below with its type and property counts.
AppsDetails
object
Details about apps installed on the resource.
2 properties
ListInventoryRequest
object
2 properties
TagKeyValuesFilters
object
3 properties
Provider
string
Cloud provider. PROVIDERUNSPECIFIED is supported only in responses.
GetObjectStoreScanMethodResponse
object
1 property1 required
SnapshotStorage
object
Details about backup snapshot storage.
3 properties
VolumeSettings
object
Provisioned volume settings.
4 properties2 required
OverrideDataClassificationsRequest
object
1 property
CancelExclusionFromBackupResponse
object
1 property1 required
OverrideEnvironmentRequest
object
1 property
GetResourceResponse
object
1 property1 required
ResourceIdFilters
object
2 properties
App
object
2 properties1 required
ExcludeFromBackupResponse
object
1 property1 required
UpdateObjectStoreScanMethodRequest
object
Object-store scan method settings to update for an AWS S3 bucket or GCP Cloud Storage bucket.
2 properties
ResourceProperties
object
Source resource properties. The properties present in this object change depending on the value set in resourceType.
1 property
ObjectStoreScanMethodSetting
object
Object-store scan method setting. If systemControlled is true, Eon decides whether the method is enabled. If systemControlled is false, enabled is required.
2 properties1 required
OverrideDataClassificationsResponse
object
1 property
ListResourcesResponse
object
3 properties2 required
DataClassesFilters
object
3 properties
EnvironmentDetails
object
Details about the resource's environment.
2 properties
Environment
string
The resource's environment: production, internal production, or staging. ENVIRONMENTUNSPECIFIED is supported only in responses.
InventoryFilterConditions
object
13 properties
ResourceTypeFilters
object
2 properties
Error
object
1 property
ObjectStoreScanMethod
object
Object-store scan method settings for an AWS S3 bucket or GCP Cloud Storage bucket.
2 properties2 required
UpdateObjectStoreScanMethodResponse
object
1 property1 required
OverrideEnvironmentResponse
object
1 property
CloudProviderFilters
object
2 properties
TagKeysFilters
object
3 properties
BackupStatusFilters
object
2 properties
Classifications
object
Resource classification details.
3 properties
EnvironmentFilters
object
2 properties
DataClassesDetails
object
Details about the resource's data classes.
2 properties
AppFilters
object
3 properties
IdFilters
object
2 properties
ResourceType
string
Resource type identifier combining cloud provider and service type. RESOURCETYPEUNSPECIFIED is supported only in responses.
DataClass
string
Data classes. Allowed values: FI, PHI, PII
AccountIdFilters
object
2 properties
InventoryVolume
object
8 properties6 required
SortResourceBy
object
List of sorting options. Sorting is applied in the order passed in the list.
2 properties2 required
InventoryResource
object
20 properties15 required
ResourceNameFilters
object
4 properties
ResourceSortField
string
Field to sort by.
ControlViolations
object
4 properties4 required
BackupStatus
string
Eon backup status. For an explanation of statuses, see [Backup Statuses](/user-guide/monitoring/backup-statuses). BACKUPPOSTURESTATUSUNSPECIFIED is supported o…
SubnetFilters
object
3 properties
SortOrder
string
Sort order. Use ASC for ascending order and DESC for descending order.
SourceStorage
object
Details about storage at the source.
1 property
AwsEc2Resource
object
Properties of the original AWS EC2 instance. Present only when resourceType is set to AWSEC2.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
