{"@context": "https://schema.org", "@type": "WebAPI", "name": "Catalog Inventory API", "description": "Catalog Inventory", "provider": {"@type": "Organization", "name": "redhat.com"}, "documentation": "https://raw.githubusercontent.com/RedHatInsights/catalog_inventory-api/master/public/doc/openapi-3-v1.0.json"}
Catalog Inventory
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://cloud.redhat.com/{basePath} http://localhost:{port}/{basePath}
auth: b a s i c
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Catalog Inventory
| method | path | what the vendor says it does |
|---|---|---|
POST | /graphql | Perform a GraphQL Query Performs a GraphQL Query |
GET | /openapi.json | Return this API document in JSON format |
GET | /service_credential_types | List ServiceCredentialTypes Returns an array of ServiceCredentialType objects ServiceCredentialType |
GET | /service_credential_types/{id} | Show an existing ServiceCredentialType Returns a ServiceCredentialType object ServiceCredentialType |
GET | /service_credentials | List ServiceCredentials Returns an array of ServiceCredential objects ServiceCredential |
GET | /service_credentials/{id} | Show an existing ServiceCredential Returns a ServiceCredential object ServiceCredential |
GET | /service_instances | List ServiceInstances Returns an array of ServiceInstance objects ServiceInstance |
GET | /service_instances/{id} | Show an existing ServiceInstance Returns a ServiceInstance object ServiceInstance |
GET | /service_inventories | List ServiceInventories Returns an array of ServiceInventory objects ServiceInventory |
GET | /service_inventories/{id} | Show an existing ServiceInventory Returns a ServiceInventory object ServiceInventory |
POST | /service_inventories/{id}/tag | Tag a ServiceInventory Tags a ServiceInventory object ServiceInventory |
GET | /service_inventories/{id}/tags | List Tags for ServiceInventory Returns an array of Tag objects ServiceInventory |
POST | /service_inventories/{id}/untag | Untag a ServiceInventory Untags a ServiceInventory object ServiceInventory |
GET | /service_offering_nodes | List ServiceOfferingNodes Returns an array of ServiceOfferingNode objects ServiceOfferingNode |
GET | /service_offering_nodes/{id} | Show an existing ServiceOfferingNode Returns a ServiceOfferingNode object ServiceOfferingNode |
GET | /service_offerings | List ServiceOfferings Returns an array of ServiceOffering objects ServiceOffering |
GET | /service_offerings/{id} | Show an existing ServiceOffering Returns a ServiceOffering object ServiceOffering |
POST | /service_offerings/{id}/applied_inventories_tags | Invokes computing of ServiceInventories tags for given ServiceOffering Returns an array of inventories tags Se |
POST | /service_offerings/{id}/order | Order an existing ServiceOffering Returns a Task id ServiceOffering |
GET | /service_offerings/{id}/service_instances | List ServiceInstances for ServiceOffering Returns an array of ServiceInstance objects ServiceOffering |
GET | /service_offerings/{id}/service_offering_nodes | List ServiceOfferingNodes for ServiceOffering Returns an array of ServiceOfferingNode objects ServiceOffering |
GET | /service_offerings/{id}/service_plans | List ServicePlans for ServiceOffering Returns an array of ServicePlan objects ServiceOffering |
GET | /service_plans | List ServicePlans Returns an array of ServicePlan objects ServicePlan |
GET | /service_plans/{id} | Show an existing ServicePlan Returns a ServicePlan object ServicePlan |
GET | /sources | List Sources Returns an array of Source objects Source |
GET | /sources/{id} | Show an existing Source Returns a Source object Source |
PATCH | /sources/{id}/incremental_refresh | Incremental Refresh an existing Source Incremental Refresh a source object Source |
PATCH | /sources/{id}/refresh | Refresh an existing Source Refresh a source object Source |
GET | /sources/{id}/service_instances | List ServiceInstances for Source Returns an array of ServiceInstance objects Source |
GET | /sources/{id}/service_inventories | List ServiceInventories for Source Returns an array of ServiceInventory objects Source |
GET | /sources/{id}/service_offering_nodes | List ServiceOfferingNodes for Source Returns an array of ServiceOfferingNode objects Source |
GET | /sources/{id}/service_offerings | List ServiceOfferings for Source Returns an array of ServiceOffering objects Source |
GET | /sources/{id}/service_plans | List ServicePlans for Source Returns an array of ServicePlan objects Source |
GET | /sources/{id}/tasks | List Tasks for Source Returns an array of Task objects Source |
GET | /tags | List Tags Returns an array of Tag objects Tags |
GET | /tasks | List Tasks Returns an array of Task objects Task |
GET | /tasks/{id} | Show an existing Task Returns a Task object Task |
PATCH | /tasks/{id} | Update an existing Task Updates a Task object Task |
specification origin: https://raw.githubusercontent.com/RedHatInsights/catalog_inventory-api/master/public/doc/o
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.