Skip to content

Commit

Permalink
update readme to remove stale information
Browse files Browse the repository at this point in the history
  • Loading branch information
kgaikwad authored and r14chandra committed Jan 30, 2025
1 parent c4d627f commit 3f30b8b
Showing 1 changed file with 4 additions and 54 deletions.
58 changes: 4 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,59 +95,9 @@ make configure-xjoin
```
Note - Before running the above commands make sure kafka and db-host-inventory containers are up and running.

## Available v1 API endpoints
## Available API endpoints

### Request
`GET /api/ros/v1/status` Shows the status of the server
Our REST API documentation can be found at /api/ros. You may access the raw OpenAPI definition [here](https://raw.githubusercontent.com/RedHatInsights/ros-backend/refs/heads/main/ros/openapi/openapi.json).
On a local instance it can be accessed on http://localhost:8000/api/ros/v1/openapi.json.

curl -v -H "Content-Type: application/json" https://cloud.redhat.com/api/ros/v1/status

### Response

HTTP/1.1 200 OK
Date: Thu, 24 Feb 2011 12:36:30 GMT
Status: 200 OK
Connection: close
Content-Type: application/json
Content-Length: 2

{"status": "Application is running!"}



### Request
`GET /api/ros/v1/systems` Shows list of all systems from Host Inventory having a Performance Profile

curl -v -H "Content-Type: application/json" https://cloud.redhat.com/api/ros/v1/systems -u rhn-username:redhat

### Response

HTTP/1.1 200 OK
Date: Thu, 24 Feb 2011 12:36:30 GMT
Status: 200 OK
Connection: close
Content-Type: application/json
Content-Length: 2

[{
"fqdn": "string",
"display_name": "string",
"inventory_id": "string",
"account": "string",
"org_id": "string",
"number_of_suggestions": 0,
"state": "string",
"performance_utilization": {
"memory": 0,
"cpu": 0,
"io": 0
},
"cloud_provider": "string",
"instance_type": "string",
"idling_time": 0,
"os": "string",
"report_date": "string"
}]


For local dev setup, please remember to use the x-rh-identity header encoded from your account number and org_id, the one used while running `make insights-upload-data` and `make ros-upload-data` commands.
For local dev setup, please remember to use the x-rh-identity header encoded from your account number and org_id, the one used while running `make insights-upload-data` command.

0 comments on commit 3f30b8b

Please sign in to comment.