Catalog Inventory
Catalog Inventory
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Catalog Inventory
Endpoints 38
ServiceCredentialType
- GETList ServiceCredentialTypes
/service_credential_types?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceCredentialType objects - GETShow an existing ServiceCredentialType
/service_credential_types/:idReturns a ServiceCredentialType object
ServiceCredential
- GETList ServiceCredentials
/service_credentials?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceCredential objects - GETShow an existing ServiceCredential
/service_credentials/:idReturns a ServiceCredential object
ServiceInstance
- GETList ServiceInstances
/service_instances?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceInstance objects - GETShow an existing ServiceInstance
/service_instances/:idReturns a ServiceInstance object
ServiceInventory
- GETList ServiceInventories
/service_inventories?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceInventory objects - GETShow an existing ServiceInventory
/service_inventories/:idReturns a ServiceInventory object - POSTTag a ServiceInventory
/service_inventories/:id/tagTags a ServiceInventory object - GETList Tags for ServiceInventory
/service_inventories/:id/tags?limit=100&offset=0&filter={}&sort_by={}Returns an array of Tag objects - POSTUntag a ServiceInventory
/service_inventories/:id/untagUntags a ServiceInventory object
ServiceOfferingNode
- GETList ServiceOfferingNodes
/service_offering_nodes?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceOfferingNode objects - GETShow an existing ServiceOfferingNode
/service_offering_nodes/:idReturns a ServiceOfferingNode object
ServiceOffering
- GETList ServiceOfferings
/service_offerings?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceOffering objects - GETShow an existing ServiceOffering
/service_offerings/:idReturns a ServiceOffering object - POSTInvokes computing of ServiceInventories tags for given ServiceOffering
/service_offerings/:id/applied_inventories_tagsReturns an array of inventories tags - POSTOrder an existing ServiceOffering
/service_offerings/:id/orderReturns a Task id - GETList ServiceInstances for ServiceOffering
/service_offerings/:id/service_instances?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceInstance objects - GETList ServiceOfferingNodes for ServiceOffering
/service_offerings/:id/service_offering_nodes?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceOfferingNode objects - GETList ServicePlans for ServiceOffering
/service_offerings/:id/service_plans?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServicePlan objects
ServicePlan
- GETList ServicePlans
/service_plans?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServicePlan objects - GETShow an existing ServicePlan
/service_plans/:idReturns a ServicePlan object
Source
- GETList Sources
/sources?limit=100&offset=0&filter={}&sort_by={}Returns an array of Source objects - GETShow an existing Source
/sources/:idReturns a Source object - PATCHIncremental Refresh an existing Source
/sources/:id/incremental_refreshIncremental Refresh a source object - PATCH Refresh an existing Source
/sources/:id/refreshRefresh a source object - GETList ServiceInstances for Source
/sources/:id/service_instances?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceInstance objects - GETList ServiceInventories for Source
/sources/:id/service_inventories?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceInventory objects - GETList ServiceOfferingNodes for Source
/sources/:id/service_offering_nodes?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceOfferingNode objects - GETList ServiceOfferings for Source
/sources/:id/service_offerings?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServiceOffering objects - GETList ServicePlans for Source
/sources/:id/service_plans?limit=100&offset=0&filter={}&sort_by={}Returns an array of ServicePlan objects - GETList Tasks for Source
/sources/:id/tasks?limit=100&offset=0&filter={}&sort_by={}Returns an array of Task objects
Tags
- GETList Tags
/tags?limit=100&offset=0&filter={}&sort_by={}Returns an array of Tag objects
Task
- GETList Tasks
/tasks?limit=100&offset=0&filter={}&sort_by={}Returns an array of Task objects - GETShow an existing Task
/tasks/:idReturns a Task object - PATCHUpdate an existing Task
/tasks/:idUpdates a Task object
- POSTPerform a GraphQL Query
/graphqlPerforms a GraphQL Query - GETReturn this API document in JSON format
/openapi.json
API details
- Base URL
https://cloud.redhat.com/{basePath}http://localhost:{port}/{basePath}- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 38 operations on 37 pathsGET 30POST 5PATCH 3
- Main resources
- Source 10ServiceOffering 7ServiceInventory 5Task 3ServiceCredential 2ServiceCredentialType 2ServiceInstance 2ServiceOfferingNode 2ServicePlan 2Tags 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Catalog Inventory in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Catalog Inventory collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List ServiceCredentialTypes” (GET /service_credential_types?limit=100&offset=0&filter={}&sort_by={}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Catalog Inventory?
Catalog Inventory It is listed under Developer tools and has 38 endpoints.
Who publishes the Catalog Inventory?
It is listed from Red Hat's public API description (an OpenAPI document), not published by Red Hat on Swastik Codes. Anyone who controls redhat.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Catalog Inventory?
Its description lists 2 base URLs: https://cloud.redhat.com/{basePath}, http://localhost:{port}/{basePath}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Catalog Inventory?
With HTTP Basic authentication (username and password).
How many endpoints does the Catalog Inventory have?
38 operations on 37 paths (30 GET, 5 POST, 3 PATCH). The largest groups are Source, ServiceOffering, ServiceInventory, Task.
Is forking the Catalog Inventory free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.