Skip to main content

Feeds

API Calls​

NameDescriptionShortcut
GET: Feed Topology informationThis method can be used to retrieve a list of feed topology parameters Description
PUT: Update feed topology infoThis method can be used to update feed topology information parameters Description
GET: Feed Weights informationThis method can be used to retrieve a list of feed weights parameters Description
PUT: Update feed weights infoThis method can be used to update feed weights information parameters Description
GET: Feed Data informationThis method can be used to retrieve a list of feed data information parameters Description
PUT: Update Data weights infoThis method can be used to update feed data information parameters Description

[GET]: List Feed topology parameters​

This method can be used to retrieve a list of feed topology parameters

Input​

GET /feeds/topology

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
 "status": {
  "message": "Success",
  "code": "200"
 },
 "data": [
  {
   "type": "gocdb",
   "feed_url": "https://somewhere.foo.bar/topology/feed",
   "paginated": "true",
   "fetch_type": [
    "item1",
    "item2"
   ],
   "uid_endpoints": "endpointA"
  }
 ]
}

[PUT]: Update topology feed parameters​

This method is used to update topology feed parameters

Input​

PUT /feeds/topology

PUT BODY​

  {
   "type": "gocdb",
   "feed_url": "https://somewhere.foo.bar/topology/feed",
   "paginated": "true",
   "fetch_type": [
    "item1",
    "item2"
   ],
   "uid_endpoints": "endpointA"
  }

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
 "status": {
  "message": "Feeds resource succesfully updated",
  "code": "200"
 },
 "data": [
  {
   "type": "gocdb",
   "feed_url": "https://somewhere2.foo.bar/topology/feed",
   "paginated": "true",
   "fetch_type": [
    "item4",
    "item5"
   ],
   "uid_endpoints": "endpointA"
  }
 ]
}

[GET]: List Feed weights parameters​

This method can be used to retrieve a list of feed weights parameters

Input​

GET /feeds/weights

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
  "status": {
    "message": "Success",
    "code": "200"
  },
  "data": [
    {
      "type": "vapor",
      "feed_url": "https://somewhere.foo.bar/weight/feed",
      "weight_type": "hepspec2006 cpu",
      "group_type": "SITES"
    }
  ]
}

[PUT]: Update topology feed parameters​

This method is used to update topology feed parameters

Input​

PUT /feeds/topology

PUT BODY​

 {
      "type": "item2",
      "feed_url": "https://somewhere.foo.bar/weight/feed",
      "weight_type": "weight_type2",
      "group_type": "group2"
}

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
  "status": {
    "message": "Feeds resource succesfully updated",
    "code": "200"
  },
  "data": [
    {
      "type": "item2",
      "feed_url": "https://somewhere2.foo.bar/weights/feed",
      "weight_type": "weight_type2",
      "group_type": "group2"
    }
  ]
}

[GET]: List Feed Data parameters​

This method can be used to retrieve a list of feed data information parameters. Data feeds refer to data coming from other tenants and used in combined reports

Input​

GET /feeds/data

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
  "status": {
    "message": "Success",
    "code": "200"
  },
  "data": [
    {
      "tenants": ["TENANT_X", "TENANT_Y"]
    }
  ]
}

[PUT]: Update data feed parameters​

This method is used to update data feed parameters

Input​

PUT /feeds/data

PUT BODY​

{
  "tenants": ["TENANT_Z", "TENANT_W"]
}

Request headers​

x-api-key: shared_key_value
Accept: application/json

Response​

Headers: Status: 200 OK

Response body​

Json Response

{
  "status": {
    "message": "Feeds resource succesfully updated",
    "code": "200"
  },
  "data": [
    {
        "tenants": ["TENANT_Z", "TENANT_W"]
    }
  ]
}