diff --git a/docs/reference/api/get-the-currently-defined-model.api.mdx b/docs/reference/api/get-the-currently-defined-model.api.mdx index 20cf1899..f54f4518 100644 --- a/docs/reference/api/get-the-currently-defined-model.api.mdx +++ b/docs/reference/api/get-the-currently-defined-model.api.mdx @@ -5,7 +5,7 @@ description: "Get the currently defined model." sidebar_label: "Get the currently defined model." hide_title: true hide_table_of_contents: true -api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"with_bases","description":"Render all base classes. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Render all base classes. Only together with kind or filter","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"aggregate_roots_only","description":"Only return aggregate roots.","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_bases","description":"Include base classes and render the base section","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_properties","description":"Render the properties of complex kinds","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_relatives","description":"Include information about relationships to other kinds.","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_metadata","description":"Include metadata information.","in":"query","schema":{"oneOf":[{"type":"boolean","description":"If true, all metadata is included."},{"type":"array","description":"List of metadata keys to include.","items":{"type":"string"}}],"default":true}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Only return aggregate roots.","type":"text/plain"},"key":"aggregate_roots_only","value":""},{"disabled":false,"description":{"content":"Include base classes and render the base section","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""},{"disabled":false,"description":{"content":"Render the properties of complex kinds","type":"text/plain"},"key":"with_properties","value":""},{"disabled":false,"description":{"content":"Include information about relationships to other kinds.","type":"text/plain"},"key":"with_relatives","value":""},{"disabled":false,"description":{"content":"Include metadata information.","type":"text/plain"},"key":"with_metadata","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -95,6 +95,11 @@ Get the currently defined model. param={{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}}} > + + + + + + + + diff --git a/docs/reference/api/load-time-series-data.api.mdx b/docs/reference/api/load-time-series-data.api.mdx index 6c898b59..584bfc59 100644 --- a/docs/reference/api/load-time-series-data.api.mdx +++ b/docs/reference/api/load-time-series-data.api.mdx @@ -5,7 +5,7 @@ description: "Load time series data." sidebar_label: "Load time series data." hide_title: true hide_table_of_contents: true -api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-09-18T15:32:44.669Z","end":"2024-09-18T15:32:44.669Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-11-11T09:22:31.382Z","end":"2024-11-11T09:22:31.382Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null diff --git a/docs/reference/api/search-all-history-events-and-return-them.api.mdx b/docs/reference/api/search-all-history-events-and-return-them.api.mdx index 532c3ac9..48bb636f 100644 --- a/docs/reference/api/search-all-history-events-and-return-them.api.mdx +++ b/docs/reference/api/search-all-history-events-and-return-them.api.mdx @@ -5,7 +5,7 @@ description: "Search all history events and return them." sidebar_label: "Search all history events and return them." hide_title: true hide_table_of_contents: true -api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -379,7 +379,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > @@ -425,7 +425,7 @@ Search all history events and return them. A section can be defined (defaults to value={"Example"} > diff --git a/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx b/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx index 798508e5..80d4dc17 100644 --- a/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx +++ b/docs/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes as list." sidebar_label: "Search the graph and return all nodes as list (this will not contain any edges)" hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -364,7 +364,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > @@ -410,7 +410,7 @@ Search the graph and return the matching nodes as list. A section can be defined value={"Example"} > diff --git a/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx b/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx index 5446aa35..1af81ae9 100644 --- a/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx +++ b/docs/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx @@ -5,7 +5,7 @@ description: "Search the graph and return the matching nodes including the trave sidebar_label: "Search the graph and return the resulting graph." hide_title: true hide_table_of_contents: true -api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} +api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" info_path: reference/api/fix-inventory-core-rest-api custom_edit_url: null @@ -369,7 +369,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > @@ -415,7 +415,7 @@ Search the graph and return the matching nodes including the traversed edges. Th value={"Example"} > diff --git a/iam/aws/edge/FixCollect.json b/iam/aws/edge/FixCollect.json index 050824be..a8efc086 100644 --- a/iam/aws/edge/FixCollect.json +++ b/iam/aws/edge/FixCollect.json @@ -14,6 +14,7 @@ "athena:ListTagsForResource", "athena:ListWorkGroups", "autoscaling:DescribeAutoScalingGroups", + "backup:GetBackupVaultAccessPolicy", "backup:ListBackupJobs", "backup:ListBackupPlans", "backup:ListBackupVaults", @@ -27,7 +28,6 @@ "backup:ListRestoreTestingPlans", "backup:ListTags", "bedrock-agent:GetAgent", - "bedrock-agent:GetAgentVersion", "bedrock-agent:GetFlow", "bedrock-agent:GetFlowVersion", "bedrock-agent:GetKnowledgeBase", @@ -73,6 +73,7 @@ "cloudtrail:ListTags", "cloudtrail:ListTrails", "cloudwatch:DescribeAlarms", + "cloudwatch:DescribeResourcePolicies", "cloudwatch:GetMetricData", "cognito-idp:ListGroups", "cognito-idp:ListTagsForResource", @@ -83,6 +84,7 @@ "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeGlobalTable", "dynamodb:DescribeTable", + "dynamodb:GetResourcePolicy", "dynamodb:ListGlobalTables", "dynamodb:ListTables", "dynamodb:ListTagsOfResource", @@ -111,6 +113,7 @@ "ecr-public:DescribeRepositories", "ecr:DescribeRepositories", "ecr:GetLifecyclePolicy", + "ecr:GetRepositoryPolicy", "ecs:DescribeCapacityProviders", "ecs:DescribeClusters", "ecs:DescribeContainerInstances", @@ -156,7 +159,9 @@ "iam:ListAccountAliases", "iam:ListInstanceProfiles", "iam:ListServerCertificates", + "inspector2:ListFindings", "kinesis:DescribeStream", + "kinesis:GetResourcePolicy", "kinesis:ListStreams", "kinesis:ListTagsForStream", "kms:DescribeKey", @@ -200,6 +205,7 @@ "route53:ListTagsForResource", "s3:GetAccountPublicAccessBlock", "s3:GetBucketAcl", + "s3:GetBucketLifecycleConfiguration", "s3:GetBucketLocation", "s3:GetBucketLogging", "s3:GetBucketPolicy", @@ -249,6 +255,7 @@ "sagemaker:ListTrials", "sagemaker:ListUserProfiles", "sagemaker:ListWorkteams", + "secretsmanager:GetResourcePolicy", "secretsmanager:ListSecrets", "servicequotas:ListServiceQuotas", "sns:GetPlatformApplicationAttributes", diff --git a/iam/aws/edge/FixMutate.json b/iam/aws/edge/FixMutate.json index aaea8fdd..eccaa8ee 100644 --- a/iam/aws/edge/FixMutate.json +++ b/iam/aws/edge/FixMutate.json @@ -25,7 +25,6 @@ "backup:TagResource", "backup:UntagResource", "bedrock-agent:DeleteAgent", - "bedrock-agent:DeleteAgentVersion", "bedrock-agent:DeleteFlow", "bedrock-agent:DeleteFlowVersion", "bedrock-agent:DeleteKnowledgeBase", diff --git a/iam/gcp/edge/fix_access.json b/iam/gcp/edge/fix_access.json index e8d4b5a4..9a48336b 100644 --- a/iam/gcp/edge/fix_access.json +++ b/iam/gcp/edge/fix_access.json @@ -3,6 +3,22 @@ "description": "Permissions required to collect resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.list", + "aiplatform.projects.locations.customJobs.list", + "aiplatform.projects.locations.datasets.list", + "aiplatform.projects.locations.endpoints.list", + "aiplatform.projects.locations.featureGroups.list", + "aiplatform.projects.locations.featurestores.list", + "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "aiplatform.projects.locations.indexEndpoints.list", + "aiplatform.projects.locations.indexes.list", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", + "aiplatform.projects.locations.models.list", + "aiplatform.projects.locations.pipelineJobs.list", + "aiplatform.projects.locations.schedules.list", + "aiplatform.projects.locations.tensorboards.list", + "aiplatform.projects.locations.trainingPipelines.list", + "aiplatform.projects.locations.tuningJobs.list", "cloudsql.backupRuns.list", "cloudsql.databases.list", "cloudsql.instances.get", diff --git a/iam/gcp/edge/fix_mutate.json b/iam/gcp/edge/fix_mutate.json index 349367b5..0a1386eb 100644 --- a/iam/gcp/edge/fix_mutate.json +++ b/iam/gcp/edge/fix_mutate.json @@ -3,6 +3,38 @@ "description": "Permissions required to mutate resources.", "stage": "GA", "includedPermissions": [ + "aiplatform.projects.locations.batchPredictionJobs.delete", + "aiplatform.projects.locations.batchPredictionJobs.setLabels", + "aiplatform.projects.locations.customJobs.delete", + "aiplatform.projects.locations.customJobs.setLabels", + "aiplatform.projects.locations.datasets.delete", + "aiplatform.projects.locations.datasets.setLabels", + "aiplatform.projects.locations.endpoints.delete", + "aiplatform.projects.locations.endpoints.setLabels", + "aiplatform.projects.locations.featureGroups.delete", + "aiplatform.projects.locations.featureGroups.setLabels", + "aiplatform.projects.locations.featurestores.delete", + "aiplatform.projects.locations.featurestores.setLabels", + "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "aiplatform.projects.locations.hyperparameterTuningJobs.setLabels", + "aiplatform.projects.locations.indexEndpoints.delete", + "aiplatform.projects.locations.indexEndpoints.setLabels", + "aiplatform.projects.locations.indexes.delete", + "aiplatform.projects.locations.indexes.setLabels", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", + "aiplatform.projects.locations.modelDeploymentMonitoringJobs.setLabels", + "aiplatform.projects.locations.models.delete", + "aiplatform.projects.locations.models.setLabels", + "aiplatform.projects.locations.pipelineJobs.delete", + "aiplatform.projects.locations.pipelineJobs.setLabels", + "aiplatform.projects.locations.schedules.delete", + "aiplatform.projects.locations.schedules.setLabels", + "aiplatform.projects.locations.tensorboards.delete", + "aiplatform.projects.locations.tensorboards.setLabels", + "aiplatform.projects.locations.trainingPipelines.delete", + "aiplatform.projects.locations.trainingPipelines.setLabels", + "aiplatform.projects.locations.tuningJobs.delete", + "aiplatform.projects.locations.tuningJobs.setLabels", "cloudsql.instances.delete", "cloudsql.instances.update", "compute.addresses.delete", diff --git a/openapi/fixcore-edge.yml b/openapi/fixcore-edge.yml index 3d73e502..ab3b2c23 100644 --- a/openapi/fixcore-edge.yml +++ b/openapi/fixcore-edge.yml @@ -57,6 +57,15 @@ paths: schema: type: boolean default: false + - name: format + description: 'The format of the returned json' + in: query + schema: + type: string + enum: + - schema + - simple + required: false - name: kind description: 'Only return information about the defined kinds. Comma separated list.' in: query @@ -71,27 +80,48 @@ paths: schema: type: string default: null - - name: with_bases - description: 'Render all base classes. Only together with kind or filter' + - name: aggregate_roots_only + description: 'Only return aggregate roots.' in: query schema: type: boolean default: false - - name: format - description: 'The format of the returned json' + - name: with_bases + description: 'Include base classes and render the base section' in: query schema: - type: string - enum: - - schema - - simple - required: false + type: boolean + default: false - name: with_property_kinds description: 'Render types of property values. Only together with kind or filter' in: query schema: type: boolean default: false + - name: with_properties + description: 'Render the properties of complex kinds' + in: query + schema: + type: boolean + default: true + - name: with_relatives + description: 'Include information about relationships to other kinds.' + in: query + schema: + type: boolean + default: true + - name: with_metadata + description: 'Include metadata information.' + in: query + schema: + oneOf: + - type: boolean + description: 'If true, all metadata is included.' + - type: array + description: 'List of metadata keys to include.' + items: + type: string + default: true responses: '200': description: 'The list of all kinds.' @@ -817,7 +847,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -832,7 +861,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -850,7 +878,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1017,7 +1044,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1032,7 +1058,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1050,7 +1075,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 @@ -1484,7 +1508,6 @@ paths: name: root metadata: cleaned: false - phantom: true protected: false application/yaml: example: | @@ -1499,7 +1522,6 @@ paths: metadata: python_type: fixlib.baseresources.GraphRoot cleaned: false - phantom: true protected: false kinds: - graph_root @@ -1517,7 +1539,6 @@ paths: metadata: python_type: fixlib.baseresources.Cloud cleaned: false - phantom: false protected: false descendant_summary: onelogin_account: 1 diff --git a/versioned_docs/version-4.X/reference/api/abort-a-batch-update.api.mdx b/versioned_docs/version-4.X/reference/api/abort-a-batch-update.api.mdx index 8cf0f75b..f83abbd6 100644 --- a/versioned_docs/version-4.X/reference/api/abort-a-batch-update.api.mdx +++ b/versioned_docs/version-4.X/reference/api/abort-a-batch-update.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nAbort a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch aborted."}}}}},"method":"delete","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Abort a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nAbort a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-configuration-model.api.mdx b/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-configuration-model.api.mdx index 77fcc1f1..511d9efc 100644 --- a/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-configuration-model.api.mdx +++ b/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-configuration-model.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["config_validation"],"requestBody":{"description":"Complete model or part of the model.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}},"responses":{"200":{"description":"OK if the model is updated successfully","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}},"400":{"description":"Message that explains the error","content":{"text/plain":{"schema":{"type":"string"}}}}},"description":"Add or update the current defined configuration model.","method":"patch","path":"/configs/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Add or update the current defined configuration model.","description":{"type":"text/plain"},"url":{"path":["configs","model"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-model.api.mdx b/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-model.api.mdx index ea0ff92d..20947a96 100644 --- a/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-model.api.mdx +++ b/versioned_docs/version-4.X/reference/api/add-or-update-the-current-defined-model.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Complete model or part of the model.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}},"responses":{"200":{"description":"OK if the model is updated successfully","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}},"400":{"description":"Message that explains the error","content":{"text/plain":{"schema":{"type":"string"}}}}},"description":"Add or update the current defined model.","method":"patch","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Add or update the current defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/add-subscription-to-subscriber.api.mdx b/versioned_docs/version-4.X/reference/api/add-subscription-to-subscriber.api.mdx index 31664342..4fba2bc0 100644 --- a/versioned_docs/version-4.X/reference/api/add-subscription-to-subscriber.api.mdx +++ b/versioned_docs/version-4.X/reference/api/add-subscription-to-subscriber.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Add a specific subscription to a subscriber.","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}},{"name":"event_type","in":"path","description":"The action event type.","required":true,"schema":{"type":"string"}},{"name":"timeout","in":"query","required":false,"description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","schema":{"type":"number","default":60}},{"name":"wait_for_completion","in":"query","required":false,"description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"The subscriber","content":{"application/json":{"schema":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}}},"method":"post","path":"/subscriber/{subscriber_id}/{event_type}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Add subscription to subscriber","description":{"content":"Add a specific subscription to a subscriber.","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id",":event_type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","type":"text/plain"},"key":"timeout","value":""},{"disabled":false,"description":{"content":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","type":"text/plain"},"key":"wait_for_completion","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"},{"disabled":false,"description":{"content":"(Required) The action event type.","type":"text/plain"},"type":"any","value":"","key":"event_type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/commit-a-batch-update.api.mdx b/versioned_docs/version-4.X/reference/api/commit-a-batch-update.api.mdx index d85297bb..da382a44 100644 --- a/versioned_docs/version-4.X/reference/api/commit-a-batch-update.api.mdx +++ b/versioned_docs/version-4.X/reference/api/commit-a-batch-update.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nCommit a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch committed."}}}}},"method":"post","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Commit a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nCommit a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/create-a-new-graph.api.mdx b/versioned_docs/version-4.X/reference/api/create-a-new-graph.api.mdx index df1401d9..13668877 100644 --- a/versioned_docs/version-4.X/reference/api/create-a-new-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/create-a-new-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The created graph with the root node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"description":"Create a new graph","method":"post","path":"/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new graph","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/create-a-new-node-under-the-given-parent-node.api.mdx b/versioned_docs/version-4.X/reference/api/create-a-new-node-under-the-given-parent-node.api.mdx index 41228ee3..4eb4ae5c 100644 --- a/versioned_docs/version-4.X/reference/api/create-a-new-node-under-the-given-parent-node.api.mdx +++ b/versioned_docs/version-4.X/reference/api/create-a-new-node-under-the-given-parent-node.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nCreate a new node under the given parent node.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}},{"name":"parent_node_id","in":"path","description":"The identifier of the parent node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The node document to create.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}},"responses":{"200":{"description":"Return the created node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"post","path":"/graph/{graph_id}/node/{node_id}/under/{parent_node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new node under the given parent node","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nCreate a new node under the given parent node.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","under",":parent_node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the parent node","type":"text/plain"},"type":"any","value":"","key":"parent_node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/create-or-replace-a-benchmark-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/create-or-replace-a-benchmark-by-its-id.api.mdx index 790af5ac..dc738700 100644 --- a/versioned_docs/version-4.X/reference/api/create-or-replace-a-benchmark-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/create-or-replace-a-benchmark-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Create or replace a benchmark by its id.","tags":["report"],"parameters":[{"name":"benchmark","in":"path","description":"The ID of the benchmark.","schema":{"type":"string"},"example":"aws_cis_1_5","required":true}],"requestBody":{"description":"The benchmark to replace.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"title":{"type":"string","description":"The title of this check collection"},"description":{"type":"string","description":"The description of this check collection"},"documentation":{"type":"string","description":"The documentation of this check collection"},"checks":{"type":"array","items":{"type":"string"},"description":"Ids of checks in this collection"},"children":{"type":"array","items":"circular(CheckCollection)","description":"Ids of child collections"}},"title":"CheckCollection"}],"properties":{"id":{"type":"string","description":"The id of this benchmark"},"framework":{"type":"string","description":"The framework of this benchmark"},"version":{"type":"string","description":"The version of this benchmark"},"clouds":{"type":"array","items":{"type":"string"},"description":"The clouds relevant for this benchmark"}},"title":"Benchmark"}}}},"responses":{"200":{"description":"The benchmark.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"title":{"type":"string","description":"The title of this check collection"},"description":{"type":"string","description":"The description of this check collection"},"documentation":{"type":"string","description":"The documentation of this check collection"},"checks":{"type":"array","items":{"type":"string"},"description":"Ids of checks in this collection"},"children":{"type":"array","items":"circular(CheckCollection)","description":"Ids of child collections"}},"title":"CheckCollection"}],"properties":{"id":{"type":"string","description":"The id of this benchmark"},"framework":{"type":"string","description":"The framework of this benchmark"},"version":{"type":"string","description":"The version of this benchmark"},"clouds":{"type":"array","items":{"type":"string"},"description":"The clouds relevant for this benchmark"}},"title":"Benchmark"}}}}},"method":"put","path":"/report/benchmark/{benchmark}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"string","framework":"string","version":"string","clouds":["string"],"title":"string","description":"string","documentation":"string","checks":["string"],"children":[null]},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create or replace a benchmark by its id.","description":{"content":"Create or replace a benchmark by its id.","type":"text/plain"},"url":{"path":["report","benchmark",":benchmark"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the benchmark.","type":"text/plain"},"type":"any","value":"","key":"benchmark"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/create-or-replace-a-check-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/create-or-replace-a-check-by-its-id.api.mdx index ac97499a..48c1fabb 100644 --- a/versioned_docs/version-4.X/reference/api/create-or-replace-a-check-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/create-or-replace-a-check-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Create or replace a check by its id.","tags":["report"],"parameters":[{"name":"check_id","in":"path","description":"The ID of the check to perform.","schema":{"type":"string"},"example":"aws_ec2_snapshot_encrypted","required":true}],"requestBody":{"description":"The check to replace.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of this check"},"provider":{"type":"string","description":"The provider of this check"},"service":{"type":"string","description":"The service of this check"},"title":{"type":"string","description":"The title of this check"},"categories":{"type":"array","items":{"type":"string"},"description":"The categories of this check"},"severity":{"type":"string","description":"The severity of this check","enum":["critical","high","medium","low","info"]},"detect":{"additionalProperties":{"type":"string"},"description":"The detect expression of this check"},"remediation":{"type":"object","properties":{"text":{"type":"string","description":"The text of the remediation"},"url":{"type":"string","description":"The url of the remediation"},"action":{"additionalProperties":{"type":"string"},"description":"Action to remediate the inspected issue"}},"title":"Remediation"},"url":{"type":"string","description":"The url of this check"},"related":{"type":"array","items":{"type":"string"},"description":"The related checks of this check"},"result_kinds":{"type":"array","items":{"type":"string"},"description":"The kinds that are returned by this check."},"risk":{"type":"string","description":"The risk we are taking if we ignore this check"}},"title":"InspectCheck"}}}},"responses":{"200":{"description":"The checks result.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of this check"},"provider":{"type":"string","description":"The provider of this check"},"service":{"type":"string","description":"The service of this check"},"title":{"type":"string","description":"The title of this check"},"categories":{"type":"array","items":{"type":"string"},"description":"The categories of this check"},"severity":{"type":"string","description":"The severity of this check","enum":["critical","high","medium","low","info"]},"detect":{"additionalProperties":{"type":"string"},"description":"The detect expression of this check"},"remediation":{"type":"object","properties":{"text":{"type":"string","description":"The text of the remediation"},"url":{"type":"string","description":"The url of the remediation"},"action":{"additionalProperties":{"type":"string"},"description":"Action to remediate the inspected issue"}},"title":"Remediation"},"url":{"type":"string","description":"The url of this check"},"related":{"type":"array","items":{"type":"string"},"description":"The related checks of this check"},"result_kinds":{"type":"array","items":{"type":"string"},"description":"The kinds that are returned by this check."},"risk":{"type":"string","description":"The risk we are taking if we ignore this check"}},"title":"InspectCheck"}}}}},"method":"put","path":"/report/check/{check_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"string","provider":"string","service":"string","title":"string","categories":["string"],"severity":"critical","remediation":{"text":"string","url":"string"},"url":"string","related":["string"],"result_kinds":["string"],"risk":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create or replace a check by its id.","description":{"content":"Create or replace a check by its id.","type":"text/plain"},"url":{"path":["report","check",":check_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the check to perform.","type":"text/plain"},"type":"any","value":"","key":"check_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/define-subscriber-with-all-subscriptions.api.mdx b/versioned_docs/version-4.X/reference/api/define-subscriber-with-all-subscriptions.api.mdx index e63b01e0..b4c12ab4 100644 --- a/versioned_docs/version-4.X/reference/api/define-subscriber-with-all-subscriptions.api.mdx +++ b/versioned_docs/version-4.X/reference/api/define-subscriber-with-all-subscriptions.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Define or redefine a subscriber with all subscriptions.\nIn case the subscriber does not exist, it is created.\nIn case the subscriber exist, all subscriptions get replaced.\n","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The list of all subscriptions.","content":{"application/json":{"schema":{"type":"array","items":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}}}},"responses":{"200":{"description":"The subscriber","content":{"application/json":{"schema":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}}},"method":"put","path":"/subscriber/{subscriber_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":[{"message_type":"string","wait_for_completion":true,"timeout":60}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Define subscriber with all subscriptions","description":{"content":"Define or redefine a subscriber with all subscriptions.\nIn case the subscriber does not exist, it is created.\nIn case the subscriber exist, all subscriptions get replaced.\n","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-a-benchmark-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/delete-a-benchmark-by-its-id.api.mdx index 43eaea28..c25a4743 100644 --- a/versioned_docs/version-4.X/reference/api/delete-a-benchmark-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-a-benchmark-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Delete a benchmark by its id.","tags":["report"],"parameters":[{"name":"benchmark","in":"path","description":"The ID of the benchmark.","schema":{"type":"string"},"example":"aws_cis_1_5","required":true}],"responses":{"204":{"description":"Empty."}},"method":"delete","path":"/report/benchmark/{benchmark}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a benchmark by its id.","description":{"content":"Delete a benchmark by its id.","type":"text/plain"},"url":{"path":["report","benchmark",":benchmark"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the benchmark.","type":"text/plain"},"type":"any","value":"","key":"benchmark"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-a-check-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/delete-a-check-by-its-id.api.mdx index 583ee218..3dd6e4b8 100644 --- a/versioned_docs/version-4.X/reference/api/delete-a-check-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-a-check-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Delete a check by its id.","tags":["report"],"parameters":[{"name":"check_id","in":"path","description":"The ID of the check to perform.","schema":{"type":"string"},"example":"aws_ec2_snapshot_encrypted","required":true}],"responses":{"204":{"description":"Empty."}},"method":"delete","path":"/report/check/{check_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a check by its id.","description":{"content":"Delete a check by its id.","type":"text/plain"},"url":{"path":["report","check",":check_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the check to perform.","type":"text/plain"},"type":"any","value":"","key":"check_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-a-configuration-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/delete-a-configuration-by-its-id.api.mdx index 80891f15..91e73b45 100644 --- a/versioned_docs/version-4.X/reference/api/delete-a-configuration-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-a-configuration-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","in":"path","required":true,"description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"204":{"description":"Signals success of this operation."}},"method":"delete","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-a-node-with-the-given-node-id.api.mdx b/versioned_docs/version-4.X/reference/api/delete-a-node-with-the-given-node-id.api.mdx index f50a5813..9824e2f5 100644 --- a/versioned_docs/version-4.X/reference/api/delete-a-node-with-the-given-node-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-a-node-with-the-given-node-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a node with the given node id.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node is deleted"}},"method":"delete","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a node with the given node id.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nDelete a node with the given node id.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-a-specific-subscription-from-the-subscriber.api.mdx b/versioned_docs/version-4.X/reference/api/delete-a-specific-subscription-from-the-subscriber.api.mdx index 6fa94de9..40e71666 100644 --- a/versioned_docs/version-4.X/reference/api/delete-a-specific-subscription-from-the-subscriber.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-a-specific-subscription-from-the-subscriber.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Delete a specific subscription from the subscriber.","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}},{"name":"event_type","in":"path","description":"The action event type.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The subscriber","content":{"application/json":{"schema":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}}},"method":"delete","path":"/subscriber/{subscriber_id}/{event_type}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a specific subscription from the subscriber.","description":{"content":"Delete a specific subscription from the subscriber.","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id",":event_type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"},{"disabled":false,"description":{"content":"(Required) The action event type.","type":"text/plain"},"type":"any","value":"","key":"event_type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-an-existing-graph.api.mdx b/versioned_docs/version-4.X/reference/api/delete-an-existing-graph.api.mdx index 843c5845..8cb2ea0e 100644 --- a/versioned_docs/version-4.X/reference/api/delete-an-existing-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-an-existing-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"truncate","in":"query","schema":{"type":"boolean"},"description":"If this parameter is set, leave the graph definition, but wipe the data."}],"responses":{"200":{"description":"Ok when the delete operation was successful","content":{"text/plain":{"example":"Graph deleted."}}}},"description":"Delete an existing graph","method":"delete","path":"/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete an existing graph","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If this parameter is set, leave the graph definition, but wipe the data.","type":"text/plain"},"key":"truncate","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/delete-by-id.api.mdx b/versioned_docs/version-4.X/reference/api/delete-by-id.api.mdx index 4361854b..60133b7b 100644 --- a/versioned_docs/version-4.X/reference/api/delete-by-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/delete-by-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Delete the subscriber with a defined id.","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"no content"}},"method":"delete","path":"/subscriber/{subscriber_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete by id","description":{"content":"Delete the subscriber with a defined id.","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"}]},"method":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/evaluate-a-cli-command.api.mdx b/versioned_docs/version-4.X/reference/api/evaluate-a-cli-command.api.mdx index 4817498c..5642bb4c 100644 --- a/versioned_docs/version-4.X/reference/api/evaluate-a-cli-command.api.mdx +++ b/versioned_docs/version-4.X/reference/api/evaluate-a-cli-command.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"This method can be used to analyze if the command can be interpreted without executing it.\nWhen this method returns a 200 OK, the command can be parsed and evaluated.\n","parameters":[{"name":"env","description":"All search parameter form the environment passed to the CLI interpreter.","in":"query","schema":{"type":"object","additionalProperties":true}}],"requestBody":{"description":"The command will be sent as request body.\nA command can contain multiple command line separated by semicolon.\nEvery single line can contain multiple commands that are combined via the pipe operator.\n","content":{"text/plain":{"schema":{"type":"string","example":"json [1,2,3,4,5,6] | count"}}}},"tags":["cli"],"responses":{"200":{"description":"When the command can be evaluated.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true}}}}},"300":{"description":"When the command can not be evaluated.","content":{"text/plain":{"schema":{"type":"string"}}}}},"method":"post","path":"/cli/evaluate","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Evaluate a cli command","description":{"content":"This method can be used to analyze if the command can be interpreted without executing it.\nWhen this method returns a 200 OK, the command can be parsed and evaluated.\n","type":"text/plain"},"url":{"path":["cli","evaluate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/execute-a-cli-command.api.mdx b/versioned_docs/version-4.X/reference/api/execute-a-cli-command.api.mdx index f4d37059..ef2f8d1b 100644 --- a/versioned_docs/version-4.X/reference/api/execute-a-cli-command.api.mdx +++ b/versioned_docs/version-4.X/reference/api/execute-a-cli-command.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"The body defines the command to execute.\nThe command is executed and the result is returned to the client.\nRequest and execution are synchronized: the request is done, when the command is done.\n","parameters":[{"name":"env","description":"All search parameter form the environment passed to the CLI interpreter.","in":"query","schema":{"type":"object","additionalProperties":true}}],"requestBody":{"description":"The command will be sent as request body.\nA command can contain multiple command line separated by semicolon.\nEvery single line can contain multiple commands that are combined via the pipe operator.\n","content":{"text/plain":{"schema":{"type":"string","example":"json [1,2,3,4,5,6] | count"}}}},"tags":["cli"],"responses":{"200":{"description":"The result of the command.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true}}},"application/x-ndjson":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}},"method":"post","path":"/cli/execute","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Execute a cli command","description":{"content":"The body defines the command to execute.\nThe command is executed and the result is returned to the client.\nRequest and execution are synchronized: the request is done, when the command is done.\n","type":"text/plain"},"url":{"path":["cli","execute"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/explain-the-search-execution-plan.api.mdx b/versioned_docs/version-4.X/reference/api/explain-the-search-execution-plan.api.mdx index 464c913b..4b416acf 100644 --- a/versioned_docs/version-4.X/reference/api/explain-the-search-execution-plan.api.mdx +++ b/versioned_docs/version-4.X/reference/api/explain-the-search-execution-plan.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Explain the runtime characteristics of a search without performing the search.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The execution plan of the database","content":{"application/json":{"schema":{"type":"object","description":"The estimated cost of a search","properties":{"estimated_cost":{"type":"integer","description":"Absolute number that shows the cost of this search. See rating for an interpreted number."},"estimated_nr_items":{"type":"integer","description":"This is the estimated number of items returned for this search.\nPlease note: it is computed based on search statistics and heuristics and does not reflect the real number.\n"},"available_nr_items":{"type":"integer","description":"This is the number of available nodes in the graph."},"full_collection_scan":{"type":"boolean","description":"Indicates, if a full collection scan is required.\nThis means, that the search does not take advantage of any indexes!\n"},"rating":{"type":"string","description":"The rating of this search.\nA simple search is usually fine.\nA complex search might be acceptable in certain cases. Maybe an index can be used to make this search simple?\nA bad search is usually something where an index is missing or the search has to be rewritten.\n","enum":["simple","complex","bad"]}},"title":"EstimatedSearchCost"}}}}},"method":"post","path":"/graph/{graph_id}/search/explain","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Explain the search execution plan","description":{"content":"Explain the runtime characteristics of a search without performing the search.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","explain"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-benchmark-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-benchmark-by-its-id.api.mdx index d44203cc..6bf0726c 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-benchmark-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-benchmark-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Get a benchmark by its id.","tags":["report"],"parameters":[{"name":"benchmark","in":"path","description":"The ID of the benchmark.","schema":{"type":"string"},"example":"aws_cis_1_5","required":true}],"responses":{"200":{"description":"The benchmark definition.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"title":{"type":"string","description":"The title of this check collection"},"description":{"type":"string","description":"The description of this check collection"},"documentation":{"type":"string","description":"The documentation of this check collection"},"checks":{"type":"array","items":{"type":"string"},"description":"Ids of checks in this collection"},"children":{"type":"array","items":"circular(CheckCollection)","description":"Ids of child collections"}},"title":"CheckCollection"}],"properties":{"id":{"type":"string","description":"The id of this benchmark"},"framework":{"type":"string","description":"The framework of this benchmark"},"version":{"type":"string","description":"The version of this benchmark"},"clouds":{"type":"array","items":{"type":"string"},"description":"The clouds relevant for this benchmark"}},"title":"Benchmark"}}}}},"method":"get","path":"/report/benchmark/{benchmark}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a benchmark by its id.","description":{"content":"Get a benchmark by its id.","type":"text/plain"},"url":{"path":["report","benchmark",":benchmark"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the benchmark.","type":"text/plain"},"type":"any","value":"","key":"benchmark"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-check-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-check-by-its-id.api.mdx index 74ec13cb..236945a2 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-check-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-check-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Get a check by its id.","tags":["report"],"parameters":[{"name":"check_id","in":"path","description":"The ID of the check to perform.","schema":{"type":"string"},"example":"aws_ec2_snapshot_encrypted","required":true}],"responses":{"200":{"description":"The checks result.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of this check"},"provider":{"type":"string","description":"The provider of this check"},"service":{"type":"string","description":"The service of this check"},"title":{"type":"string","description":"The title of this check"},"categories":{"type":"array","items":{"type":"string"},"description":"The categories of this check"},"severity":{"type":"string","description":"The severity of this check","enum":["critical","high","medium","low","info"]},"detect":{"additionalProperties":{"type":"string"},"description":"The detect expression of this check"},"remediation":{"type":"object","properties":{"text":{"type":"string","description":"The text of the remediation"},"url":{"type":"string","description":"The url of the remediation"},"action":{"additionalProperties":{"type":"string"},"description":"Action to remediate the inspected issue"}},"title":"Remediation"},"url":{"type":"string","description":"The url of this check"},"related":{"type":"array","items":{"type":"string"},"description":"The related checks of this check"},"result_kinds":{"type":"array","items":{"type":"string"},"description":"The kinds that are returned by this check."},"risk":{"type":"string","description":"The risk we are taking if we ignore this check"}},"title":"InspectCheck"}}}}},"method":"get","path":"/report/check/{check_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a check by its id.","description":{"content":"Get a check by its id.","type":"text/plain"},"url":{"path":["report","check",":check_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the check to perform.","type":"text/plain"},"type":"any","value":"","key":"check_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-configuration-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-configuration-by-its-id.api.mdx index ac525373..603c90e0 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-configuration-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-configuration-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nFetch a configuration by id.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"No configuration for this key."}},"method":"get","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nFetch a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-configuration-validation-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-configuration-validation-by-its-id.api.mdx index 93556363..0954a257 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-configuration-validation-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-configuration-validation-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nFetch the validation of a configuration by id.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}},"application/yaml":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"404":{"description":"No config validation for this key."}},"method":"get","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a configuration validation by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nFetch the validation of a configuration by id.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-list-of-all-running-batch-updates.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-list-of-all-running-batch-updates.api.mdx index dc524e1b..06cd7324 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-list-of-all-running-batch-updates.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-list-of-all-running-batch-updates.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet a list of all running batch updates.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"the id of the change."},"created":{"type":"string","description":"datetime in utc, when the batch update has been created"},"affected_nodes":{"type":"array","items":{"type":"string"},"description":"The root nodes of the subgraphs that will be changed during the update"}},"example":[{"id":"XYQaijCNJUVc","created":"2021-06-29T13:53:39.329Z","affected_nodes":["sub_graph_root_1","sub_graph_root_2"]}],"title":"BatchUpdate"}}}}},"method":"get","path":"/graph/{graph_id}/batch","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a list of all running batch updates","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet a list of all running batch updates.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-a-node-with-the-given-node-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-a-node-with-the-given-node-id.api.mdx index 630876d3..041c2cae 100644 --- a/versioned_docs/version-4.X/reference/api/get-a-node-with-the-given-node-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-a-node-with-the-given-node-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Return the defined node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"get","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get a node with the given node id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-all-configuration-keys-that-have-a-model-defined.api.mdx b/versioned_docs/version-4.X/reference/api/get-all-configuration-keys-that-have-a-model-defined.api.mdx index 37bee44d..a1c2efed 100644 --- a/versioned_docs/version-4.X/reference/api/get-all-configuration-keys-that-have-a-model-defined.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-all-configuration-keys-that-have-a-model-defined.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys that have a model defined.\n","tags":["config_validation"],"responses":{"200":{"description":"All configuration keys that have a model.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys that have a model defined.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys that have a model defined.\n","type":"text/plain"},"url":{"path":["configs","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-all-configuration-keys.api.mdx b/versioned_docs/version-4.X/reference/api/get-all-configuration-keys.api.mdx index 3b54c004..96059ecd 100644 --- a/versioned_docs/version-4.X/reference/api/get-all-configuration-keys.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-all-configuration-keys.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys in the system.\n","tags":["config"],"responses":{"200":{"description":"All configuration keys.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"method":"get","path":"/configs","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get all configuration keys","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet all configuration keys in the system.\n","type":"text/plain"},"url":{"path":["configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-information-about-cli.api.mdx b/versioned_docs/version-4.X/reference/api/get-information-about-cli.api.mdx index f3731d12..f688f9ef 100644 --- a/versioned_docs/version-4.X/reference/api/get-information-about-cli.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-information-about-cli.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nGet information about CLI\n","tags":["cli"],"responses":{"200":{"description":"name, information and help of available commands.","content":{"application/json":{"schema":{"type":"object","description":"Information about the CLI","properties":{"commands":{"description":"All available commands","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}},"replacements":{"description":"All available replacements with current value","type":"object","additionalProperties":{"type":"string"}},"alias_names":{"description":"All available aliases","type":"object","additionalProperties":{"type":"string"}},"alias_templates":{"description":"All available alias template name.","type":"array","items":{"type":"object","description":"Information about a CLI command","properties":{"name":{"type":"string","description":"The name of the CLI command."},"args":{"oneOf":[{"type":"array"},{"type":"object","title":"CLICommandArg"}]},"info":{"type":"string","description":"Short description."},"help":{"type":"string","description":"Help text of the CLI command."},"source":{"type":"boolean","description":"Indicates, if the command is allowed in source position (first command in a chain)."}},"title":"CLICommand"}}},"title":"CLIInfo"}}}}},"method":"get","path":"/cli/info","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get information about CLI","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nGet information about CLI\n","type":"text/plain"},"url":{"path":["cli","info"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-root-of-a-specific-graph.api.mdx b/versioned_docs/version-4.X/reference/api/get-root-of-a-specific-graph.api.mdx index ee643ba5..948cc2de 100644 --- a/versioned_docs/version-4.X/reference/api/get-root-of-a-specific-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-root-of-a-specific-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The graph with the root node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}},"404":{"description":"The graph does not exist"}},"description":"Get root of a specific graph","method":"get","path":"/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get root of a specific graph","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-subscriber-by-id.api.mdx b/versioned_docs/version-4.X/reference/api/get-subscriber-by-id.api.mdx index 283d1850..e0071f3f 100644 --- a/versioned_docs/version-4.X/reference/api/get-subscriber-by-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-subscriber-by-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Get the subscriber with a defined id.","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The subscriber","content":{"application/json":{"schema":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}},"404":{"description":"No subscriber found","content":{"text/plain":{"schema":{"type":"string","example":"No subscriber with this id"}}}}},"method":"get","path":"/subscriber/{subscriber_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get subscriber by id","description":{"content":"Get the subscriber with a defined id.","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-configuration-model.api.mdx b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-configuration-model.api.mdx index 654457ad..cbd11cbf 100644 --- a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-configuration-model.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-configuration-model.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["config_validation"],"parameters":[{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined configuration model.","method":"get","path":"/configs/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined configuration model.","description":{"type":"text/plain"},"url":{"path":["configs","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model-as-svg-uml-image.api.mdx b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model-as-svg-uml-image.api.mdx index 841f92f2..9a04d2c9 100644 --- a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model-as-svg-uml-image.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model-as-svg-uml-image.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"output","description":"The output format.","in":"query","schema":{"type":"string","enum":["svg","png","puml"],"default":"svg"},"required":false},{"name":"show","description":"comma separated list of resources to show. Entries can be regexps.","in":"query","schema":{"type":"string"},"required":false,"explode":false,"example":"aws_ec2_instance,gcp.*"},{"name":"hide","description":"comma separated list of resources to hide. Entries can be regexps.\nhide takes precedence over show.\n","in":"query","schema":{"type":"string"},"required":false,"explode":false,"example":"aws_ec2_instance,gcp.*"},{"name":"with_inheritance","description":"Include inheritance relations in the model.","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_base_classes","description":"Include all base classes of visible entries","in":"query","schema":{"type":"boolean","default":true}},{"name":"with_subclasses","description":"Include all descendant classes of visible entries","in":"query","schema":{"type":"boolean","default":false}},{"name":"dependency","description":"comma separated list of dependency relationships.\n","in":"query","schema":{"type":"string"},"required":false,"explode":false,"example":"default"},{"name":"with_predecessors","description":"Include all predecessors of selected entries","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_successors","description":"Include all successors of selected entries","in":"query","schema":{"type":"boolean","default":false}},{"name":"with_properties","description":"Show properties of selected entries","in":"query","schema":{"oneOf":[{"type":"boolean"},{"type":"string"}],"default":true}},{"name":"link_classes","description":"Add anchor links to classes.","in":"query","schema":{"type":"boolean","default":false}},{"name":"aggregate_roots","description":"Show aggregate roots.","in":"query","schema":{"type":"boolean","default":true}},{"name":"sort_props","description":"Sort properties by name.","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Returns the model as uml diagram in svg format"}},"description":"Get the currently defined model as svg uml image.","method":"get","path":"/graph/{graph_id}/model/uml","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model as svg uml image.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model","uml"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The output format.","type":"text/plain"},"key":"output","value":""},{"disabled":false,"description":{"content":"comma separated list of resources to show. Entries can be regexps.","type":"text/plain"},"key":"show","value":""},{"disabled":false,"description":{"content":"comma separated list of resources to hide. Entries can be regexps.\nhide takes precedence over show.\n","type":"text/plain"},"key":"hide","value":""},{"disabled":false,"description":{"content":"Include inheritance relations in the model.","type":"text/plain"},"key":"with_inheritance","value":""},{"disabled":false,"description":{"content":"Include all base classes of visible entries","type":"text/plain"},"key":"with_base_classes","value":""},{"disabled":false,"description":{"content":"Include all descendant classes of visible entries","type":"text/plain"},"key":"with_subclasses","value":""},{"disabled":false,"description":{"content":"comma separated list of dependency relationships.\n","type":"text/plain"},"key":"dependency","value":""},{"disabled":false,"description":{"content":"Include all predecessors of selected entries","type":"text/plain"},"key":"with_predecessors","value":""},{"disabled":false,"description":{"content":"Include all successors of selected entries","type":"text/plain"},"key":"with_successors","value":""},{"disabled":false,"description":{"content":"Show properties of selected entries","type":"text/plain"},"key":"with_properties","value":""},{"disabled":false,"description":{"content":"Add anchor links to classes.","type":"text/plain"},"key":"link_classes","value":""},{"disabled":false,"description":{"content":"Show aggregate roots.","type":"text/plain"},"key":"aggregate_roots","value":""},{"disabled":false,"description":{"content":"Sort properties by name.","type":"text/plain"},"key":"sort_props","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx index 20cf1899..acf3211f 100644 --- a/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-the-currently-defined-model.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["model"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"flat","description":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","in":"query","schema":{"type":"boolean","default":false}},{"name":"kind","description":"Only return information about the defined kinds. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"filter","description":"Only return information about kinds that include given string. Comma separated list.","in":"query","explode":false,"schema":{"type":"string","default":null}},{"name":"with_bases","description":"Render all base classes. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}},{"name":"format","description":"The format of the returned json","in":"query","schema":{"type":"string","enum":["schema","simple"]},"required":false},{"name":"with_property_kinds","description":"Render types of property values. Only together with kind or filter","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The list of all kinds.","content":{"application/json":{"schema":{"description":"Definition of a kind","type":"array","items":{"oneOf":[{"type":"object","title":"StringKind"},{"type":"object","title":"NumberKind"},{"type":"object","title":"BooleanKind"},{"type":"object","title":"DateTimeKind"},{"type":"object","title":"ArrayKind"},{"type":"object","title":"DateKind"},{"type":"object","title":"ComplexKind"},{"type":"object","description":"A simple dictionary where all keys and values are strings","title":"StringDictKind"}]},"example":[{"fqn":"test.dice","runtime_kind":"int32","description":"A dice has 6 sides.","minimum":1,"maximum":6},{"fqn":"test.social_security_number","runtime_kind":"string","description":"A dice has 6 sides.","pattern":"^(?!666|000|9\\d{2})\\d{3}-(?!00)\\d{2}-(?!0{4})\\d{4}$"},{"fqn":"test.base","properties":[{"name":"kind","kind":"string","required":true,"description":"The kind of this compound type."},{"name":"name","kind":"string","description":"The name of the resource.","required":true},{"name":"tags","kind":"dictionary[string, string]","description":"Tags that describe the resource.","required":false}]},{"fqn":"test.person","bases":["test.base"],"properties":[{"name":"fortune","kind":"test.dice","description":"The current dice value.","required":true},{"name":"ssn","kind":"test.social_security_number","description":"The social security number of this person.","required":true}]}],"title":"Kind"}}}}},"description":"Get the currently defined model.","method":"get","path":"/graph/{graph_id}/model","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the currently defined model.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","model"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If true, the hierarchy of complex kinds is flattened, holding all properties and all merged metadata.","type":"text/plain"},"key":"flat","value":""},{"disabled":false,"description":{"content":"Only return information about the defined kinds. Comma separated list.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Only return information about kinds that include given string. Comma separated list.","type":"text/plain"},"key":"filter","value":""},{"disabled":false,"description":{"content":"Render all base classes. Only together with kind or filter","type":"text/plain"},"key":"with_bases","value":""},{"disabled":false,"description":{"content":"The format of the returned json","type":"text/plain"},"key":"format","value":""},{"disabled":false,"description":{"content":"Render types of property values. Only together with kind or filter","type":"text/plain"},"key":"with_property_kinds","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/get-the-public-keys-of-the-configured-jwt-issuer.api.mdx b/versioned_docs/version-4.X/reference/api/get-the-public-keys-of-the-configured-jwt-issuer.api.mdx index b0c31268..680e4b61 100644 --- a/versioned_docs/version-4.X/reference/api/get-the-public-keys-of-the-configured-jwt-issuer.api.mdx +++ b/versioned_docs/version-4.X/reference/api/get-the-public-keys-of-the-configured-jwt-issuer.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["authorization"],"responses":{"200":{"description":"The public keys of the configured JWT issuer.","content":{"application/json":{"example":"{\n \"keys\": [\n {\n \"alg\": \"sha256WithRSAEncryption\",\n \"e\": \"AQAB\",\n \"kid\": \"fDKvq05HG0...\",\n \"kty\": \"RSA\",\n \"n\": \"u7cp95GkUOj...\",\n \"use\": \"sig\",\n \"x5c\": [ \"MIIDoTCCAomgAw...\" ],\n \"x5t\": \"DMpDIyR...\",\n \"x5t#S256\": \"fDKvq05HG0Oz....\"\n }\n ]\n}\n"}}}},"description":"Get the public keys of the configured JWT issuer.","method":"get","path":"/.well-known/jwks.json","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Get the public keys of the configured JWT issuer.","description":{"type":"text/plain"},"url":{"path":[".well-known","jwks.json"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-checks.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-checks.api.mdx index c7640573..59d2b7c5 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-checks.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-checks.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"List all checks.","tags":["report"],"parameters":[{"name":"provider","in":"query","description":"Filter by provider.","schema":{"type":"string"},"example":"aws"},{"name":"service","in":"query","description":"Filter by service.","schema":{"type":"string"},"example":"ec2"},{"name":"category","in":"query","description":"Filter by category.","schema":{"type":"string"},"example":"security"},{"name":"kind","in":"query","description":"Filter by kind.","schema":{"type":"string"},"example":"aws_ec2_instance"},{"name":"ids_only","in":"query","description":"Filter by check ids.","schema":{"type":"boolean"}},{"name":"id","in":"query","description":"Filter by check ids.","schema":{"type":"string"},"explode":false,"example":"aws_ec2_public_ip_address,aws_ec2_old_instances"}],"responses":{"200":{"description":"List of checks.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of this check"},"provider":{"type":"string","description":"The provider of this check"},"service":{"type":"string","description":"The service of this check"},"title":{"type":"string","description":"The title of this check"},"categories":{"type":"array","items":{"type":"string"},"description":"The categories of this check"},"severity":{"type":"string","description":"The severity of this check","enum":["critical","high","medium","low","info"]},"detect":{"additionalProperties":{"type":"string"},"description":"The detect expression of this check"},"remediation":{"type":"object","properties":{"text":{"type":"string","description":"The text of the remediation"},"url":{"type":"string","description":"The url of the remediation"},"action":{"additionalProperties":{"type":"string"},"description":"Action to remediate the inspected issue"}},"title":"Remediation"},"url":{"type":"string","description":"The url of this check"},"related":{"type":"array","items":{"type":"string"},"description":"The related checks of this check"},"result_kinds":{"type":"array","items":{"type":"string"},"description":"The kinds that are returned by this check."},"risk":{"type":"string","description":"The risk we are taking if we ignore this check"}},"title":"InspectCheck"}}}}}},"method":"get","path":"/report/checks","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all checks.","description":{"content":"List all checks.","type":"text/plain"},"url":{"path":["report","checks"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter by provider.","type":"text/plain"},"key":"provider","value":""},{"disabled":false,"description":{"content":"Filter by service.","type":"text/plain"},"key":"service","value":""},{"disabled":false,"description":{"content":"Filter by category.","type":"text/plain"},"key":"category","value":""},{"disabled":false,"description":{"content":"Filter by kind.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Filter by check ids.","type":"text/plain"},"key":"ids_only","value":""},{"disabled":false,"description":{"content":"Filter by check ids.","type":"text/plain"},"key":"id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-graphs.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-graphs.api.mdx index 7f22e12f..68559b75 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-graphs.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-graphs.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_management"],"responses":{"200":{"description":"The names of all graphs","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"example":["main","test"]}}}}},"description":"List all graphs","method":"get","path":"/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all graphs","description":{"type":"text/plain"},"url":{"path":["graph"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-outstanding-work-items.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-outstanding-work-items.api.mdx index 5a9189dc..6608aa2b 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-outstanding-work-items.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-outstanding-work-items.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"All work items that are initiated but not done are listed via this endpoint.\n","tags":["work_queue"],"responses":{"200":{"description":"The list of all outstanding work items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"task":{"type":"object","properties":{"task_id":{"type":"string"},"task_name":{"type":"string"},"data":{"type":"object","additionalProperties":true},"attrs":{"type":"object","additionalProperties":true}}},"worker":{"type":"string"},"retry_counter":{"type":"integer"},"deadline":{"type":"string"}}}}}}}},"method":"get","path":"/work/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all outstanding work items","description":{"content":"All work items that are initiated but not done are listed via this endpoint.\n","type":"text/plain"},"url":{"path":["work","list"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-resources-that-match-a-given-check.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-resources-that-match-a-given-check.api.mdx index dfbf341d..30c7d456 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-resources-that-match-a-given-check.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-resources-that-match-a-given-check.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Perform the check identified by the given check identifier on the graph with provided identifier. It is possible to filter the list further by providing a list of account ids.\n","tags":["report"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"check_id","in":"path","description":"The ID of the check to perform.","schema":{"type":"string"},"example":"aws_ec2_snapshot_encrypted","required":true},{"name":"accounts","in":"query","description":"Only show resources in one of the provided accounts.","schema":{"type":"string"},"explode":false,"example":"123456789012,123456789013"}],"responses":{"200":{"description":"The checks result.","content":{"application/json":{"schema":{"items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/ndjson":{"schema":{"items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}}},"method":"get","path":"/report/check/{check_id}/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all resources that match a given check.","description":{"content":"Perform the check identified by the given check identifier on the graph with provided identifier. It is possible to filter the list further by providing a list of account ids.\n","type":"text/plain"},"url":{"path":["report","check",":check_id","graph",":graph_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Only show resources in one of the provided accounts.","type":"text/plain"},"key":"accounts","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The ID of the check to perform.","type":"text/plain"},"type":"any","value":"","key":"check_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-subscribers-for-a-given-event-type.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-subscribers-for-a-given-event-type.api.mdx index 410e4d0c..eba3dffb 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-subscribers-for-a-given-event-type.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-subscribers-for-a-given-event-type.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Get all subscriptions of registered subscribers","tags":["subscriptions"],"parameters":[{"name":"event_type","in":"path","description":"The type of message","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of all subscribers which are subscribed","content":{"application/json":{"schema":{"type":"array","items":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}}}},"method":"get","path":"/subscribers/for/{event_type}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all subscribers for a given event type","description":{"content":"Get all subscriptions of registered subscribers","type":"text/plain"},"url":{"path":["subscribers","for",":event_type"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The type of message","type":"text/plain"},"type":"any","value":"","key":"event_type"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-all-subscriptions.api.mdx b/versioned_docs/version-4.X/reference/api/list-all-subscriptions.api.mdx index ba60609d..356d347f 100644 --- a/versioned_docs/version-4.X/reference/api/list-all-subscriptions.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-all-subscriptions.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Get all subscriptions of all subscribers in the system","tags":["subscriptions"],"responses":{"200":{"description":"The list of all subscribers with all subscriptions","content":{"application/json":{"schema":{"type":"array","items":{"description":"A subscriber has a unique name and a list of subscriptions","type":"object","properties":{"id":{"type":"string","description":"The identifier of this subscriber"},"subscriptions":{"type":"object","description":"The dictionary of subscriptions, where the key is the message type","additionalProperties":{"description":"The definition of an action subscription","type":"object","properties":{"message_type":{"type":"string","description":"The name of the action to listen to"},"wait_for_completion":{"type":"boolean","description":"If an action is sent to this subscriber, the event sender should wait until this\nsubscriber has processed the message and send a done message.\nThis is the expected behaviour of every actor and defaults to true.\n","default":true},"timeout":{"type":"number","description":"This is the duration in seconds this subscriber has time to execute the action.\nAfter this time the sender assumes a failure and rejects the result of this actor.\n","default":60}},"title":"Subscription"}}},"title":"Subscriber"}}}}}},"method":"get","path":"/subscribers","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List all subscriptions","description":{"content":"Get all subscriptions of all subscribers in the system","type":"text/plain"},"url":{"path":["subscribers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/list-available-benchmarks.api.mdx b/versioned_docs/version-4.X/reference/api/list-available-benchmarks.api.mdx index 4714c701..ed4b6fb5 100644 --- a/versioned_docs/version-4.X/reference/api/list-available-benchmarks.api.mdx +++ b/versioned_docs/version-4.X/reference/api/list-available-benchmarks.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"List available benchmarks.","tags":["report"],"parameters":[{"name":"providers","in":"query","description":"Comma separated list of cloud provides. All if not defined.","schema":{"type":"string"},"example":"aws"},{"name":"benchmarks","in":"query","description":"Comma separated list of benchmarks. All if not defined.","schema":{"type":"string"},"example":"aws_cis_1_5,aws_cis_1_6","explode":false},{"name":"with_checks","in":"query","description":"Include check definition into the benchmark","schema":{"type":"boolean","default":false}},{"name":"short","in":"query","description":"Reduce the information to top level properties.","schema":{"type":"boolean","default":false}},{"name":"ids_only","in":"query","description":"Return only the ids of the benchmarks.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List of benchmarks.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"title":{"type":"string","description":"The title of this check collection"},"description":{"type":"string","description":"The description of this check collection"},"documentation":{"type":"string","description":"The documentation of this check collection"},"checks":{"type":"array","items":{"type":"string"},"description":"Ids of checks in this collection"},"children":{"type":"array","items":"circular(CheckCollection)","description":"Ids of child collections"}},"title":"CheckCollection"}],"properties":{"id":{"type":"string","description":"The id of this benchmark"},"framework":{"type":"string","description":"The framework of this benchmark"},"version":{"type":"string","description":"The version of this benchmark"},"clouds":{"type":"array","items":{"type":"string"},"description":"The clouds relevant for this benchmark"}},"title":"Benchmark"}}}}}},"method":"get","path":"/report/benchmarks","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"List available benchmarks.","description":{"content":"List available benchmarks.","type":"text/plain"},"url":{"path":["report","benchmarks"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Comma separated list of cloud provides. All if not defined.","type":"text/plain"},"key":"providers","value":""},{"disabled":false,"description":{"content":"Comma separated list of benchmarks. All if not defined.","type":"text/plain"},"key":"benchmarks","value":""},{"disabled":false,"description":{"content":"Include check definition into the benchmark","type":"text/plain"},"key":"with_checks","value":""},{"disabled":false,"description":{"content":"Reduce the information to top level properties.","type":"text/plain"},"key":"short","value":""},{"disabled":false,"description":{"content":"Return only the ids of the benchmarks.","type":"text/plain"},"key":"ids_only","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx b/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx index 6c898b59..c8c80528 100644 --- a/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx +++ b/versioned_docs/version-4.X/reference/api/load-time-series-data.api.mdx @@ -5,9 +5,9 @@ description: "Load time series data." sidebar_label: "Load time series data." hide_title: true hide_table_of_contents: true -api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-09-18T15:32:44.669Z","end":"2024-09-18T15:32:44.669Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} +api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-11-11T09:22:31.743Z","end":"2024-11-11T09:22:31.743Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx b/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx index c1c4048b..140f4572 100644 --- a/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx +++ b/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nMerge a given graph with the existing graph under marked merge nodes as batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"query","description":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","required":false,"schema":{"default":null,"type":"string"}},{"name":"wait_for_result","in":"query","description":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","schema":{"default":true,"type":"boolean"}}],"requestBody":{"description":"The graph is sent as newline delimited json, where each line holds a document, which is either a node or an edge.","required":true,"content":{"application/x-ndjson":{"schema":{"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"example":[{"id":"a","data":{"kind":"loadbalancer","ip":"1.2.3.4","mathod":"roundrobin"}},{"id":"b","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"b","edge_type":"default"},{"id":"c","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"c","edge_type":"default"}]}}},"responses":{"200":{"description":"Return a summary of actions that has been applied.","content":{"application/json":{"schema":{"description":"Summary of a graph change action","type":"object","properties":{"nodes_created":{"description":"The number of nodes that have been created.","type":"integer"},"nodes_updates":{"description":"The number of nodes that have been updated.","type":"integer"},"nodes_deleted":{"description":"The number of nodes that have been deleted.","type":"integer"},"edges_created":{"description":"The number of edges that have been created.","type":"integer"},"edges_updated":{"description":"The number of edges that have been updated.","type":"integer"},"edges_deleted":{"description":"The number of edges that have been deleted.","type":"integer"}},"title":"GraphUpdate"}}}}},"method":"post","path":"/graph/{graph_id}/batch/merge","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Merge a given graph with the existing graph under marked merge nodes as batch update.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nMerge a given graph with the existing graph under marked merge nodes as batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch","merge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A batch identifier is a string that uniquely identifies the batch update. If this parameter is omitted, a new batch identifier is created automatically. The resulting batch identifier can be retrieved via the response message.\n","type":"text/plain"},"key":"batch_id","value":""},{"disabled":false,"description":{"content":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","type":"text/plain"},"key":"wait_for_result","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"application/x-ndjson"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes.api.mdx b/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes.api.mdx index 71883c00..1a9f7d20 100644 --- a/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes.api.mdx +++ b/versioned_docs/version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"wait_for_result","in":"query","description":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","schema":{"default":true,"type":"boolean"}}],"requestBody":{"description":"The graph is sent as newline delimited json, where each line holds a document, which is either a node or an edge.","required":true,"content":{"application/x-ndjson":{"schema":{"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"example":[{"id":"a","data":{"kind":"loadbalancer","ip":"1.2.3.4","mathod":"roundrobin"}},{"id":"b","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"b","edge_type":"default"},{"id":"c","data":{"kind":"compute_instance","machine_type":"gt-5","cores":24}},{"from":"a","to":"c","edge_type":"default"}]}}},"responses":{"200":{"description":"Return a summary of actions that has been applied.","content":{"application/json":{"schema":{"description":"Summary of a graph change action","type":"object","properties":{"nodes_created":{"description":"The number of nodes that have been created.","type":"integer"},"nodes_updates":{"description":"The number of nodes that have been updated.","type":"integer"},"nodes_deleted":{"description":"The number of nodes that have been deleted.","type":"integer"},"edges_created":{"description":"The number of edges that have been created.","type":"integer"},"edges_updated":{"description":"The number of edges that have been updated.","type":"integer"},"edges_deleted":{"description":"The number of edges that have been deleted.","type":"integer"}},"title":"GraphUpdate"}}}}},"description":"Merge a given graph with the existing graph under marked merge nodes.","method":"post","path":"/graph/{graph_id}/merge","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Merge a given graph with the existing graph under marked merge nodes.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","merge"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If this parameter is set, the request will block until the batch update is finished. The response will contain the batch identifier and the result of the batch update.\n","type":"text/plain"},"key":"wait_for_result","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"application/x-ndjson"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/merge-deferred-edges-by-a-given-task-id.api.mdx b/versioned_docs/version-4.X/reference/api/merge-deferred-edges-by-a-given-task-id.api.mdx index d4f0a30c..dc9439de 100644 --- a/versioned_docs/version-4.X/reference/api/merge-deferred-edges-by-a-given-task-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/merge-deferred-edges-by-a-given-task-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"All existing deferred edges will be replaced by the definition of all deferred edges of the given task ids.\nWe might be able to track deferred edges more specifically in the future.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The task ids to merge.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Return a summary of actions that has been applied.","content":{"application/json":{"schema":{"type":"object","properties":{"processed":{"type":"integer","description":"Number of processed edges"},"updated":{"type":"integer","description":"Number of updated edges"},"deleted":{"type":"integer","description":"Number of deleted edges"}}}}}}},"method":"post","path":"/graph/{graph_id}/merge/deferred_edges","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":["string"],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Merge deferred edges by a given task id","description":{"content":"All existing deferred edges will be replaced by the definition of all deferred edges of the given task ids.\nWe might be able to track deferred edges more specifically in the future.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","merge","deferred_edges"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/patch-a-configuration-by-its-id.api.mdx b/versioned_docs/version-4.X/reference/api/patch-a-configuration-by-its-id.api.mdx index d774b2f7..d0c9f180 100644 --- a/versioned_docs/version-4.X/reference/api/patch-a-configuration-by-its-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/patch-a-configuration-by-its-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"patch","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be patched without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/patch-a-list-of-nodes.api.mdx b/versioned_docs/version-4.X/reference/api/patch-a-list-of-nodes.api.mdx index 11515406..59df3fc4 100644 --- a/versioned_docs/version-4.X/reference/api/patch-a-list-of-nodes.api.mdx +++ b/versioned_docs/version-4.X/reference/api/patch-a-list-of-nodes.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Apply a patch on existing nodes. Non existing nodes are not updated!\nConsider to stream the request body as new line delimited json (application/x-ndjson).\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/x-ndjson":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the node."},"reported":{"type":"object","additionalProperties":true},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}}}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the node."},"reported":{"type":"object","additionalProperties":true},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}}}}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"patch","path":"/graph/{graph_id}/nodes","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":[{"id":"string","reported":{},"desired":{},"metadata":{}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a list of nodes.","description":{"content":"Apply a patch on existing nodes. Non existing nodes are not updated!\nConsider to stream the request body as new line delimited json (application/x-ndjson).\n","type":"text/plain"},"url":{"path":["graph",":graph_id","nodes"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/patch-a-node-with-the-given-node-id-in-given-section.api.mdx b/versioned_docs/version-4.X/reference/api/patch-a-node-with-the-given-node-id-in-given-section.api.mdx index 8e03cdd4..ed381c3e 100644 --- a/versioned_docs/version-4.X/reference/api/patch-a-node-with-the-given-node-id-in-given-section.api.mdx +++ b/versioned_docs/version-4.X/reference/api/patch-a-node-with-the-given-node-id-in-given-section.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a node with the given node id in given section\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"path","required":true,"description":"The name of the section used for all property paths. If not defined root is assumed.","schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}/section/{section}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Patch a node with the given node id in given section","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nPatch a node with the given node id in given section\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","section",":section"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"type":"any","value":"","key":"section"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/perform-a-benchmark-on-a-graph.api.mdx b/versioned_docs/version-4.X/reference/api/perform-a-benchmark-on-a-graph.api.mdx index 291c592f..ebaddf94 100644 --- a/versioned_docs/version-4.X/reference/api/perform-a-benchmark-on-a-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/perform-a-benchmark-on-a-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Perform a benchmark with the given identifier on a graph with a given identifier.","tags":["report"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"benchmark","in":"path","description":"The name of the benchmark to perform","schema":{"type":"string"},"example":"aws_cis_1.5","required":true},{"name":"accounts","description":"Comma separated list of account ids to include in the benchmark.\nIf no value is given, all accounts are included.\n","in":"query","schema":{"type":"string"},"required":false,"explode":false,"example":"123456789012,123456789013"},{"name":"action","in":"query","description":"The action to perform. You can either run (create) or load the benchmark.\nLoading the benchmark requires, that a benchmark has been synchronized to the database before.\nIn case the resources haven't changed since the last synchronization, the result is the same,\nbut the load action is much faster.\n","schema":{"type":"string","enum":["run","load"],"default":"run"}}],"responses":{"200":{"description":"The checks result.","content":{"application/ndjson":{"schema":{"description":"A graph is just an array of nodes and edges","type":"array","items":{"discriminator":{"propertyName":"type","mapping":{"node":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of this node."},"type":{"type":"string"},"reported":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}},"example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},"edge":{"type":"object","properties":{"from":{"description":"The id of node to start from","type":"string"},"to":{"description":"The id of the node to go to","type":"string"},"edge_type":{"description":"The type of this edge","type":"string","enum":["default","delete"]}},"example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}}},"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"title":"Graph"}},"application/json":{"schema":{"description":"A graph is just an array of nodes and edges","type":"array","items":{"discriminator":{"propertyName":"type","mapping":{"node":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of this node."},"type":{"type":"string"},"reported":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}},"example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},"edge":{"type":"object","properties":{"from":{"description":"The id of node to start from","type":"string"},"to":{"description":"The id of the node to go to","type":"string"},"edge_type":{"description":"The type of this edge","type":"string","enum":["default","delete"]}},"example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}}},"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"title":"Graph"}}}}},"method":"get","path":"/report/benchmark/{benchmark}/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Perform a benchmark on a graph.","description":{"content":"Perform a benchmark with the given identifier on a graph with a given identifier.","type":"text/plain"},"url":{"path":["report","benchmark",":benchmark","graph",":graph_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Comma separated list of account ids to include in the benchmark.\nIf no value is given, all accounts are included.\n","type":"text/plain"},"key":"accounts","value":""},{"disabled":false,"description":{"content":"The action to perform. You can either run (create) or load the benchmark.\nLoading the benchmark requires, that a benchmark has been synchronized to the database before.\nIn case the resources haven't changed since the last synchronization, the result is the same,\nbut the load action is much faster.\n","type":"text/plain"},"key":"action","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The name of the benchmark to perform","type":"text/plain"},"type":"any","value":"","key":"benchmark"}]},"header":[{"key":"Accept","value":"application/ndjson"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph.api.mdx b/versioned_docs/version-4.X/reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph.api.mdx index 6ac2b48c..2ae075c9 100644 --- a/versioned_docs/version-4.X/reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Perform a benchmark by defining the check criteria on a graph with a given identifier.","tags":["report"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"provider","in":"query","description":"Filter by provider.","schema":{"type":"string"},"example":"aws"},{"name":"service","in":"query","description":"Filter by service.","schema":{"type":"string"},"example":"ec2"},{"name":"category","in":"query","description":"Filter by category.","schema":{"type":"string"},"example":"security"},{"name":"kind","in":"query","description":"Filter by kind.","schema":{"type":"string"},"example":"aws_ec2_instance"},{"name":"accounts","description":"Comma separated list of account ids to include in the benchmark.\nIf no value is given, all accounts are included.\n","in":"query","schema":{"type":"string"},"required":false,"explode":false,"example":"123456789012,123456789013"}],"responses":{"200":{"description":"The checks result.","content":{"application/ndjson":{"schema":{"description":"A graph is just an array of nodes and edges","type":"array","items":{"discriminator":{"propertyName":"type","mapping":{"node":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of this node."},"type":{"type":"string"},"reported":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}},"example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},"edge":{"type":"object","properties":{"from":{"description":"The id of node to start from","type":"string"},"to":{"description":"The id of the node to go to","type":"string"},"edge_type":{"description":"The type of this edge","type":"string","enum":["default","delete"]}},"example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}}},"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"title":"Graph"}},"application/json":{"schema":{"description":"A graph is just an array of nodes and edges","type":"array","items":{"discriminator":{"propertyName":"type","mapping":{"node":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of this node."},"type":{"type":"string"},"reported":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"desired":{"type":"object","additionalProperties":true},"metadata":{"type":"object","additionalProperties":true}},"example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},"edge":{"type":"object","properties":{"from":{"description":"The id of node to start from","type":"string"},"to":{"description":"The id of the node to go to","type":"string"},"edge_type":{"description":"The type of this edge","type":"string","enum":["default","delete"]}},"example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}}},"oneOf":[{"type":"object","example":{"type":"node","id":"id-in-graph","reported":{"kind":"test.person","name":"Batman","city":"Gotham"},"desired":{"clean":true},"metadata":{"version":1}},"title":"NodeInGraph"},{"type":"object","example":{"type":"edge","from":"node_id_of_a_in_graph","to":"node_id_of_b_in_graph","edge_type":"default"},"title":"Edge"}]},"title":"Graph"}}}}},"method":"get","path":"/report/checks/graph/{graph_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Perform a dynamically assembled benchmark on a graph.","description":{"content":"Perform a benchmark by defining the check criteria on a graph with a given identifier.","type":"text/plain"},"url":{"path":["report","checks","graph",":graph_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter by provider.","type":"text/plain"},"key":"provider","value":""},{"disabled":false,"description":{"content":"Filter by service.","type":"text/plain"},"key":"service","value":""},{"disabled":false,"description":{"content":"Filter by category.","type":"text/plain"},"key":"category","value":""},{"disabled":false,"description":{"content":"Filter by kind.","type":"text/plain"},"key":"kind","value":""},{"disabled":false,"description":{"content":"Comma separated list of account ids to include in the benchmark.\nIf no value is given, all accounts are included.\n","type":"text/plain"},"key":"accounts","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Accept","value":"application/ndjson"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server.api.mdx b/versioned_docs/version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server.api.mdx index 8f391b81..ea75990a 100644 --- a/versioned_docs/version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server.api.mdx +++ b/versioned_docs/version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"parameters":[{"name":"path","description":"Note: swagger does not allow to define a nested path with slashes.","in":"path","required":true,"schema":{"type":"string","example":"api/v1/metadata"}}],"tags":["tsdb"],"responses":{"404":{"description":"If the response is coming from Fix (no FixVia header), this means that tsdb is not configured, so a request can not be made.","content":{"text/plain":{"schema":{"type":"string","example":"404: No tsdb defined. No tsdb defined. Adjust fix.core configuration."}}}},"502":{"description":"If the response is coming from Fix (no FixVia header), this means that the configured tsdb server can not be reached.","content":{"text/plain":{"schema":{"type":"string","example":"502. tsdb server is not reachable"}}}},"default":{"headers":{"ViaFix":{"description":"This header indicates, that the response is created by the tsdb server and Fix is only a proxy.\nDepending on this header: you have to interpret the response differently.\n","schema":{"type":"string","example":"1.1 node1"}}},"description":"The response from the tsdb."}},"description":"Proxy request to a configured tsdb server.","method":"get","path":"/tsdb/{path}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Proxy request to a configured tsdb server.","description":{"type":"text/plain"},"url":{"path":["tsdb",":path"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Note: swagger does not allow to define a nested path with slashes.","type":"text/plain"},"type":"any","value":"","key":"path"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/replace-a-configuration-validation-with-given-id.api.mdx b/versioned_docs/version-4.X/reference/api/replace-a-configuration-validation-with-given-id.api.mdx index 228ed431..e2bdb79f 100644 --- a/versioned_docs/version-4.X/reference/api/replace-a-configuration-validation-with-given-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/replace-a-configuration-validation-with-given-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration validation identified by id with provided value.\n","tags":["config_validation"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the configuration validation to replace.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}},"responses":{"200":{"description":"The configuration validation.","content":{"application/json":{"schema":{"description":"The validation for this configuration value.","type":"object","properties":{"id":{"description":"The identifier of the related configuration.","type":"string"},"external_validation":{"description":"True, if an external entity should validate a config change.\nIn this case fixcore is emitting a task on the task queue of type validate_config.\nIt expectes a listener to pickup this task and report back, if the configuration is valid or not.\n","type":"boolean"}},"title":"ConfigValidation"}}}}},"method":"put","path":"/config/{config_id}/validation","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"string","external_validation":true},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration validation with given id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration validation identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id","validation"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the configuration validation to replace.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/replace-a-configuration-with-given-id.api.mdx b/versioned_docs/version-4.X/reference/api/replace-a-configuration-with-given-id.api.mdx index 26b3ae5e..67344ddd 100644 --- a/versioned_docs/version-4.X/reference/api/replace-a-configuration-with-given-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/replace-a-configuration-with-given-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","required":true,"in":"path","description":"the identifier of the config to get.","schema":{"type":"string"}},{"name":"validate","required":false,"in":"query","description":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","schema":{"type":"boolean"}},{"name":"dry_run","required":false,"in":"query","description":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The configuration","headers":{"Fix-Config-Revision":{"description":"The revision of this config","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"method":"put","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Replace a configuration with given id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nReplace a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"This parameter can be used to turn off config validation.\nIn case it is not defined or not set to false, every configuaration value is validated.\n","type":"text/plain"},"key":"validate","value":""},{"disabled":false,"description":{"content":"This parameter can be used to test if the config could be updated without really changing it.\nIt will perform all validations but not store the new value.\n","type":"text/plain"},"key":"dry_run","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/retrieve-the-certificate-authorities-public-certificate.api.mdx b/versioned_docs/version-4.X/reference/api/retrieve-the-certificate-authorities-public-certificate.api.mdx index 440a6d73..58bc8996 100644 --- a/versioned_docs/version-4.X/reference/api/retrieve-the-certificate-authorities-public-certificate.api.mdx +++ b/versioned_docs/version-4.X/reference/api/retrieve-the-certificate-authorities-public-certificate.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"The certificate served here is only used to sign and validate.","tags":["certificate"],"responses":{"200":{"description":"The certificate in PEM format.","content":{"application/x-pem-file":{"schema":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIUEtDMkiSa2FYM5LVhZiPlspro39owDQYJKoZIhvcNAQEL\nBQAweDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcM\nDVNhbiBGcmFuY2lzY28xHjAcBgNVBAoMFVNvbWUgRW5naW5lZXJpbmcgSW5jLjEc\nMBoGA1UEAwwTQ2xvdWRrZWVwZXIgUm9vdCBDQTAeFw0yMTEyMjIwOTQ1NDJaFw0y\nMjEyMjIwOTQ1NDJaMBsxGTAXBgNVBAMMEHNvbWUuZW5naW5lZXJpbmcwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5VIgOTR95jIxWJZHXUo6FUv4CyDn/\nfZWxZQmFXC8c6SqspRNpXMgZq+riTm+yQ1l/kc2xVpr5S8tVeFGGjzaCcf51DMSx\nj7SaUXP2oDtMi7e9wkfTaoN3z3erVwJl39znKQviEL8G7vYPCn7oDqt1HHry7ctN\ncrEMWYSQXUYe4s++K1q65VyGNBp6AcIrmefoH0pGARZs4MbvR74U44xsj25VFS+W\nM3YSomBv4oB4QkqlcVWOU/Tlx7Tq7ASfkSqEkUigKMx/QKrdeQHxCkEtmjbiHhOk\nVaCYsVbi8pVvE5URNrycvzJXGdimSL8pVZ8M89gUDoxUoiAneSswoRZrAgMBAAGj\nMTAvMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUH\nAwIwDQYJKoZIhvcNAQELBQADggEBAA70yqOYfYtguJKji+IeIsZflNH2DH6lZ2Xe\nmv5suRbjuKEApSDUL59rpliT1dAcX6+cfKDQjzZ/7VWmp+XZmehGRlhRNWJMzsOz\nXv8/5l0LL59yN4w4FNq2cREcLj35RVYUU7lssNr/RNE9xNMHeqLdC4oW22PUi1lY\niq212G5yQTg31lVmzA9Uzvz+p/A8CG24tSBFbydSIogprmALS+5rnso0bWJ3Owf1\nCVz6Dc9UM4kBWDsb+iTffXwbgSDbG+lJ+9TEndcAzb7Zxs6ghMtv/PKR/tmw+O32\n3da9fAZE2eZoDvssH6LAUcFjtP9SFb8ZOdHJ15l279vzgCvWsvU=\n-----END CERTIFICATE-----\n"}}}}},"method":"get","path":"/ca/cert","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Retrieve the certificate authorities public certificate.","description":{"content":"The certificate served here is only used to sign and validate.","type":"text/plain"},"url":{"path":["ca","cert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/x-pem-file"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx b/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx index 532c3ac9..bfedc009 100644 --- a/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-all-history-events-and-return-them.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search all history events and return them.","description":{"content":"Search all history events and return them.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result.api.mdx b/versioned_docs/version-4.X/reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result.api.mdx index adaeeaf2..67ddd3b3 100644 --- a/versioned_docs/version-4.X/reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Search and aggregate history events and return the aggregation result.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"before","in":"query","description":"Optional parameter to get all history events before the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Optional parameter to get all history events after the given timestamp","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The aggregation search to perform","content":{"text/plain":{"schema":{"type":"string","example":"aggregate(reported.kind: sum(1) as nodes): is(node)\n"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"description":"The result of the aggregation. The properties depend on the aggregation function.","type":"object","additionalProperties":true,"example":"[\n { \"count\": 60, \"kind\": \"aws_ec2_instance_type\", \"mem_avg\": 28.45, \"mem_max\": 64, \"mem_min\": 1, \"mem_total\": 1707 },\n { \"count\": 105686, \"kind\": \"gcp_machine_type\", \"mem_avg\": 213.57744392143945, \"mem_max\": 3844, \"mem_min\": 0.599609375, \"mem_total\": 22572145.73828125 }\n]\n","title":"Aggregated"}},"application/x-ndjson":{"schema":{"description":"The result of the aggregation. The properties depend on the aggregation function.","type":"object","additionalProperties":true,"example":"[\n { \"count\": 60, \"kind\": \"aws_ec2_instance_type\", \"mem_avg\": 28.45, \"mem_max\": 64, \"mem_min\": 1, \"mem_total\": 1707 },\n { \"count\": 105686, \"kind\": \"gcp_machine_type\", \"mem_avg\": 213.57744392143945, \"mem_max\": 3844, \"mem_min\": 0.599609375, \"mem_total\": 22572145.73828125 }\n]\n","title":"Aggregated"}}}}},"method":"post","path":"/graph/{graph_id}/search/history/aggregate","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search and aggregate history events and return the aggregation result.","description":{"content":"Search and aggregate history events and return the aggregation result.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","aggregate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx b/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx deleted file mode 100644 index 24cfa884..00000000 --- a/versioned_docs/version-4.X/reference/api/search-history-events-and-provide-the-number-of-events-over-time.api.mdx +++ /dev/null @@ -1,243 +0,0 @@ ---- -id: search-history-events-and-provide-the-number-of-events-over-time -title: "Search history events and provide the number of events over time." -description: "Search all history events and a histogram over time." -sidebar_label: "Search history events and provide the number of events over time." -hide_title: true -hide_table_of_contents: true -api: {"description":"Search all history events and a histogram over time.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"before","in":"query","description":"Count all history events before the given timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"after","in":"query","description":"Count all history events after the given timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"granularity","in":"query","description":"Optional parameter to define the granularity of the timeline","required":false,"schema":{"type":"string","format":"duration"}},{"name":"change","in":"query","description":"Optional parameter to get all history events with the given change type","required":false,"schema":{"type":"string","enum":["node_created","node_updated","node_deleted"]}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(volume) and reported.volume_size>100"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"example":"[\n { \"at\": \"2024-07-14T00:00:00.000Z\", \"group\": { \"change\": \"node_created\" }, \"v\": 170 },\n { \"at\": \"2024-07-15T00:00:00.000Z\", \"group\": { \"change\": \"node_updated\" }, \"v\": 833 },\n { \"at\": \"2024-07-15T00:00:00.000Z\", \"group\": { \"change\": \"node_created\" }, \"v\": 1166 }\n]\n"}}}},"method":"post","path":"/graph/{graph_id}/search/history/timeline","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search history events and provide the number of events over time.","description":{"content":"Search all history events and a histogram over time.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","history","timeline"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"(Required) Count all history events before the given timestamp","type":"text/plain"},"key":"before","value":""},{"disabled":false,"description":{"content":"(Required) Count all history events after the given timestamp","type":"text/plain"},"key":"after","value":""},{"disabled":false,"description":{"content":"Optional parameter to define the granularity of the timeline","type":"text/plain"},"key":"granularity","value":""},{"disabled":false,"description":{"content":"Optional parameter to get all history events with the given change type","type":"text/plain"},"key":"change","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} -sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api -custom_edit_url: null -hide_send_button: true ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import Markdown from "@theme/Markdown"; -import Heading from "@theme/Heading"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; - - - - - - - - -Search all history events and a histogram over time. A section can be defined (defaults to `/` == root) to interpret relative property paths. Example: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2) - - - - -
- -

- Path Parameters -

-
-
    - - - -
-
-
- -

- Query Parameters -

-
-
    - - - - - - - - - - - -
-
-
- -
- -

- Body -

-
-
- - - The search to perform - - -
-
    -
    - - - string - - -
    -
-
- -
-
- - -
- - - The result of this search in the defined format - - -
- - - - -
- - - Schema - -
- -
    - any -
-
- - - - - - - - -
- - -
-
diff --git a/versioned_docs/version-4.X/reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result.api.mdx index 4829680c..12b5d04d 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Search and aggregate the graph and return the resulting aggregated data.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The aggregation search to perform","content":{"text/plain":{"schema":{"type":"string","example":"aggregate(reported.kind: sum(1) as nodes): is(node)\n"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"description":"The result of the aggregation. The properties depend on the aggregation function.","type":"object","additionalProperties":true,"example":"[\n { \"count\": 60, \"kind\": \"aws_ec2_instance_type\", \"mem_avg\": 28.45, \"mem_max\": 64, \"mem_min\": 1, \"mem_total\": 1707 },\n { \"count\": 105686, \"kind\": \"gcp_machine_type\", \"mem_avg\": 213.57744392143945, \"mem_max\": 3844, \"mem_min\": 0.599609375, \"mem_total\": 22572145.73828125 }\n]\n","title":"Aggregated"}},"application/x-ndjson":{"schema":{"description":"The result of the aggregation. The properties depend on the aggregation function.","type":"object","additionalProperties":true,"example":"[\n { \"count\": 60, \"kind\": \"aws_ec2_instance_type\", \"mem_avg\": 28.45, \"mem_max\": 64, \"mem_min\": 1, \"mem_total\": 1707 },\n { \"count\": 105686, \"kind\": \"gcp_machine_type\", \"mem_avg\": 213.57744392143945, \"mem_max\": 3844, \"mem_min\": 0.599609375, \"mem_total\": 22572145.73828125 }\n]\n","title":"Aggregated"}}}}},"method":"post","path":"/graph/{graph_id}/search/aggregate","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the aggregate function on the specified graph and return the aggregation result.","description":{"content":"Search and aggregate the graph and return the resulting aggregated data.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","aggregate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx index 798508e5..827883ff 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/list","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all nodes as list (this will not contain any edges)","description":{"content":"Search the graph and return the matching nodes as list.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","list"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path.api.mdx index f541d482..4a011776 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"prop","in":"query","example":"tags\n","description":"The property path to search for with an optional predicate","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","example":"[\n \"owner\",\n \"checksum/secret\",\n \"prometheus.io/path\",\n]\n","items":{"type":"string"}}}}}},"description":"Search the graph and return all possible attribute names for given property path.","method":"post","path":"/graph/{graph_id}/property/attributes","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all possible attribute names for given property path.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","property","attributes"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"(Required) The property path to search for with an optional predicate","type":"text/plain"},"key":"prop","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path.api.mdx index 1bc35936..987da0c0 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"prop","in":"query","example":"tags\n","description":"The property path to search for with an optional predicate","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","example":"[\n \"owner\",\n \"checksum/secret\",\n \"prometheus.io/path\",\n]\n","items":{"type":"string"}}}}}},"description":"Search the graph and return all possible attribute values for given property path.","method":"post","path":"/graph/{graph_id}/property/values","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return all possible attribute values for given property path.","description":{"type":"text/plain"},"url":{"path":["graph",":graph_id","property","values"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"(Required) The property path to search for with an optional predicate","type":"text/plain"},"key":"prop","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx index 5446aa35..c2f44011 100644 --- a/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx +++ b/versioned_docs/version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"with-kind","description":"Include the kind of the node in the result node.","schema":{"type":"boolean","default":false},"in":"query","required":false},{"name":"count","in":"query","description":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","required":false,"schema":{"type":"boolean","default":true}},{"name":"search_timeout","in":"query","description":"Optional duration the search is allowed to run.","required":false,"schema":{"type":"string","example":"30s"}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"The result of this search in the defined format","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}},"application/x-ndjson":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"},"example":"{\"type\": \"node\", \"id\": \"root\", \"revision\": \"123\", \"reported\": {\"kind\": \"graph_root\", \"id\": \"root\", \"tags\": {}, \"name\": \"root\"}}\n{\"type\": \"node\", \"id\": \"cloud_id\", \"revision\": \"12\", \"reported\": {\"kind\": \"cloud\", \"id\": \"onelogin\", \"tags\": {}, \"name\": \"onelogin\", \"ctime\": \"2021-12-14T08:49:52Z\", \"age\": \"6d7h\"}}\n{\"type\": \"edge\", \"from\": \"root\", \"to\": \"cloud_id\", \"edge_type\": \"default\"}\n"},"text/plain":{"example":"reported:\n kind: graph_root\n id: root\n tags: {}\n name: root\nmetadata:\n cleaned: false\n phantom: true\n protected: false\n"},"application/yaml":{"example":"id: root\ntype: node\nrevision: _daGy-Bu---\nreported:\n kind: graph_root\n id: root\n tags: { }\n name: root\nmetadata:\n python_type: fixlib.baseresources.GraphRoot\n cleaned: false\n phantom: true\n protected: false\nkinds:\n - graph_root\n---\nid: 2RZlTX9yzeBwTNT_H1KZVA\ntype: node\nrevision: _daGy-Bi---\nreported:\n kind: cloud\n id: onelogin\n tags: { }\n name: onelogin\n ctime: '2021-12-14T08:49:52Z'\n age: 6d7h\nmetadata:\n python_type: fixlib.baseresources.Cloud\n cleaned: false\n phantom: false\n protected: false\n descendant_summary:\n onelogin_account: 1\n onelogin_region: 1\n onelogin_user: 1034\n descendant_count: 1036\nancestors:\n cloud:\n reported:\n name: onelogin\n id: onelogin\nkinds:\n - cloud\n - base_cloud\n - resource\n---\ntype: edge\nfrom: root\nto: 2RZlTX9yzeBwTNT_H1KZVA\nedge_type: default\n"},"application/vnd.graphml+xml":{"example":"\n \n \n \n \n \n \n \n graph_root\n root\n root\n \n \n cloud\n onelogin\n onelogin\n 2021-12-14T08:49:52Z\n 6d7h\n \n \n \n\n"},"application/vnd.cytoscape+json":{"example":"{\n \"data\": [ ],\n \"directed\": true,\n \"elements\": {\n \"edges\": [\n {\n \"data\": {\n \"source\": \"root\",\n \"target\": \"cloud_id\"\n }\n }\n ],\n \"nodes\": [\n {\n \"data\": {\n \"id\": \"root\",\n \"kind\": \"graph_root\",\n \"name\": \"root\",\n \"tags\": { },\n \"value\": \"root\"\n }\n },\n {\n \"data\": {\n \"age\": \"6d7h\",\n \"ctime\": \"2021-12-14T08:49:52Z\",\n \"id\": \"onelogin\",\n \"kind\": \"cloud\",\n \"name\": \"onelogin\",\n \"tags\": { },\n \"value\": \"cloud_id\"\n }\n }\n ]\n },\n \"multigraph\": false\n}\n"},"text/vnd.graphviz":{"example":"digraph {\nrankdir=LR\noverlap=false\nsplines=true\nnode [shape=Mrecord colorscheme=paired12]\nedge [arrowsize=0.5]\n \"root\" [label=\"root|graph_root\", style=filled fillcolor=1];\n \"2RZlTX9yzeBwTNT_H1KZVA\" [label=\"onelogin|cloud\", style=filled fillcolor=2];\n \"root\" -> \"2RZlTX9yzeBwTNT_H1KZVA\"\n subgraph \"graph_root\" {\n \"root\"\n \"2RZlTX9yzeBwTNT_H1KZVA\"\n }\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/graph","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Search the graph and return the resulting graph.","description":{"content":"Search the graph and return the matching nodes including the traversed edges.\nThe resulting data can be interpreted as a graph.\nA section can be defined (defaults to `/` == root) to interpret relative property paths.\nExample: is(volume) and (reported.age>23d or desired.clean==true or metadata.version==2)\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","graph"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"Include the kind of the node in the result node.","type":"text/plain"},"key":"with-kind","value":""},{"disabled":false,"description":{"content":"Optional parameter to get a Ck-Element-Count header which returns the number of returned json elements","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Optional duration the search is allowed to run.","type":"text/plain"},"key":"search_timeout","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/send-a-ping-to-the-system-and-expect-a-pong.api.mdx b/versioned_docs/version-4.X/reference/api/send-a-ping-to-the-system-and-expect-a-pong.api.mdx index c5ec7fa2..40849e3a 100644 --- a/versioned_docs/version-4.X/reference/api/send-a-ping-to-the-system-and-expect-a-pong.api.mdx +++ b/versioned_docs/version-4.X/reference/api/send-a-ping-to-the-system-and-expect-a-pong.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["system"],"responses":{"200":{"description":"The pong answer","content":{"text/plain":{"schema":{"type":"string","example":"pong"}}}}},"description":"Send a ping to the system and expect a pong.","method":"get","path":"/system/ping","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Send a ping to the system and expect a pong.","description":{"type":"text/plain"},"url":{"path":["system","ping"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/send-analytics-events-to-the-server.api.mdx b/versioned_docs/version-4.X/reference/api/send-analytics-events-to-the-server.api.mdx index 32ede435..189ddbff 100644 --- a/versioned_docs/version-4.X/reference/api/send-analytics-events-to-the-server.api.mdx +++ b/versioned_docs/version-4.X/reference/api/send-analytics-events-to-the-server.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Send analytics events to the server.\nThe server will either drop or forward the event based on the user defined settings.\n","tags":["system"],"requestBody":{"description":"The analytics events to send","content":{"application/json":{"schema":{"type":"array","items":{"description":"An analytics event.","type":"object","properties":{"system":{"type":"string","description":"The system that emitted the event."},"kind":{"type":"string","description":"The kind of event."},"context":{"type":"object","description":"The context of the event.","additionalProperties":{"type":"string"}},"counters":{"type":"object","description":"The counters of the event.","additionalProperties":{"type":"integer"}},"at":{"type":"string","description":"The time of the event in IS0 8601 date time."}},"title":"AnalyticsEvent"}}}}},"responses":{"204":{"description":"The events were accepted"}},"method":"post","path":"/analytics","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":[{"system":"string","kind":"string","context":{},"counters":{},"at":"string"}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Send analytics events to the server","description":{"content":"Send analytics events to the server.\nThe server will either drop or forward the event based on the user defined settings.\n","type":"text/plain"},"url":{"path":["analytics"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/show-the-structure-of-the-search.api.mdx b/versioned_docs/version-4.X/reference/api/show-the-structure-of-the-search.api.mdx index a70f7938..b5067bb8 100644 --- a/versioned_docs/version-4.X/reference/api/show-the-structure-of-the-search.api.mdx +++ b/versioned_docs/version-4.X/reference/api/show-the-structure-of-the-search.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Structure of the search as json object.\n","tags":["graph_search"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"search is(graph_root) and reported.name==\"root\" --> | aggregate kind as resource_kind: sum(1) as count\n"}}}},"responses":{"200":{"description":"The execution plan of the database","content":{"application/json":{"example":"{\n \"aggregate\": {\n \"group_by\": [\n {\n \"as\": \"resource_kind\",\n \"name\": \"kind\"\n }\n ],\n \"group_func\": [\n {\n \"as\": \"count\",\n \"function\": \"sum\",\n \"name\": 1,\n \"ops\": []\n }\n ]\n },\n \"parts\": [\n {\n \"limit\": null,\n \"navigation\": {\n \"direction\": \"out\",\n \"edge_types\": [\n \"default\"\n ],\n \"start\": 1,\n \"until\": 1\n },\n \"sort\": [\n {\n \"name\": \"reported.kind\",\n \"order\": \"asc\"\n },\n {\n \"name\": \"reported.name\",\n \"order\": \"asc\"\n },\n {\n \"name\": \"reported.id\",\n \"order\": \"asc\"\n }\n ],\n \"tag\": null,\n \"term\": {\n \"kind\": \"combined\",\n \"left\": {\n \"kind\": \"is\",\n \"kinds\": [\n \"graph_root\"\n ]\n },\n \"op\": \"and\",\n \"right\": {\n \"args\": {},\n \"kind\": \"predicate\",\n \"name\": \"reported.name\",\n \"op\": \"==\",\n \"value\": \"root\"\n }\n },\n \"with\": null\n },\n {\n \"limit\": null,\n \"navigation\": null,\n \"sort\": [\n {\n \"name\": \"reported.kind\",\n \"order\": \"asc\"\n },\n {\n \"name\": \"reported.name\",\n \"order\": \"asc\"\n },\n {\n \"name\": \"reported.id\",\n \"order\": \"asc\"\n }\n ],\n \"tag\": null,\n \"term\": {\n \"kind\": \"all\"\n },\n \"with\": null\n }\n ],\n \"preamble\": {}\n}\n"}}}},"method":"post","path":"/graph/{graph_id}/search/structure","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Show the structure of the search","description":{"content":"Structure of the search as json object.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","structure"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/sidebar.ts b/versioned_docs/version-4.X/reference/api/sidebar.ts index 03d18ab6..c7ff17cf 100644 --- a/versioned_docs/version-4.X/reference/api/sidebar.ts +++ b/versioned_docs/version-4.X/reference/api/sidebar.ts @@ -4,85 +4,78 @@ const sidebar: SidebarsConfig = { apisidebar: [ { type: 'doc', - id: 'reference/api/fix-inventory-core-rest-api', + id: 'version-4.X/reference/api/fix-inventory-core-rest-api', }, { type: 'category', label: 'graph_search', link: { type: 'doc', - id: 'reference/api/graph-search', + id: 'version-4.X/reference/api/graph-search', }, items: [ { type: 'doc', - id: 'reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges', + id: 'version-4.X/reference/api/search-the-graph-and-return-all-nodes-as-list-this-will-not-contain-any-edges', label: 'Search the graph and return all nodes as list (this will not contain any edges)', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-the-graph-and-return-the-resulting-graph', + id: 'version-4.X/reference/api/search-the-graph-and-return-the-resulting-graph', label: 'Search the graph and return the resulting graph.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result', + id: 'version-4.X/reference/api/search-the-aggregate-function-on-the-specified-graph-and-return-the-aggregation-result', label: 'Search the aggregate function on the specified graph and return the aggregation result.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/show-the-structure-of-the-search', + id: 'version-4.X/reference/api/show-the-structure-of-the-search', label: 'Show the structure of the search', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/explain-the-search-execution-plan', + id: 'version-4.X/reference/api/explain-the-search-execution-plan', label: 'Explain the search execution plan', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-history-events-and-provide-the-number-of-events-over-time', - label: - 'Search history events and provide the number of events over time.', - className: 'api-method post', - }, - { - type: 'doc', - id: 'reference/api/search-all-history-events-and-return-them', + id: 'version-4.X/reference/api/search-all-history-events-and-return-them', label: 'Search all history events and return them.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result', + id: 'version-4.X/reference/api/search-and-aggregate-history-events-and-return-the-aggregation-result', label: 'Search and aggregate history events and return the aggregation result.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path', + id: 'version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-names-for-given-property-path', label: 'Search the graph and return all possible attribute names for given property path.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path', + id: 'version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path', label: 'Search the graph and return all possible attribute values for given property path.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path', + id: 'version-4.X/reference/api/search-the-graph-and-return-all-possible-attribute-values-for-given-property-path', label: 'Search the graph and return all possible attribute values for given property path.', className: 'api-method post', @@ -94,68 +87,68 @@ const sidebar: SidebarsConfig = { label: 'graph_management', link: { type: 'doc', - id: 'reference/api/graph-management', + id: 'version-4.X/reference/api/graph-management', }, items: [ { type: 'doc', - id: 'reference/api/list-all-graphs', + id: 'version-4.X/reference/api/list-all-graphs', label: 'List all graphs', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-root-of-a-specific-graph', + id: 'version-4.X/reference/api/get-root-of-a-specific-graph', label: 'Get root of a specific graph', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/create-a-new-graph', + id: 'version-4.X/reference/api/create-a-new-graph', label: 'Create a new graph', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/delete-an-existing-graph', + id: 'version-4.X/reference/api/delete-an-existing-graph', label: 'Delete an existing graph', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes', + id: 'version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes', label: 'Merge a given graph with the existing graph under marked merge nodes.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/merge-deferred-edges-by-a-given-task-id', + id: 'version-4.X/reference/api/merge-deferred-edges-by-a-given-task-id', label: 'Merge deferred edges by a given task id', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update', + id: 'version-4.X/reference/api/merge-a-given-graph-with-the-existing-graph-under-marked-merge-nodes-as-batch-update', label: 'Merge a given graph with the existing graph under marked merge nodes as batch update.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/get-a-list-of-all-running-batch-updates', + id: 'version-4.X/reference/api/get-a-list-of-all-running-batch-updates', label: 'Get a list of all running batch updates', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/commit-a-batch-update', + id: 'version-4.X/reference/api/commit-a-batch-update', label: 'Commit a batch update', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/abort-a-batch-update', + id: 'version-4.X/reference/api/abort-a-batch-update', label: 'Abort a batch update', className: 'api-method delete', }, @@ -166,42 +159,42 @@ const sidebar: SidebarsConfig = { label: 'node_management', link: { type: 'doc', - id: 'reference/api/node-management', + id: 'version-4.X/reference/api/node-management', }, items: [ { type: 'doc', - id: 'reference/api/patch-a-list-of-nodes', + id: 'version-4.X/reference/api/patch-a-list-of-nodes', label: 'Patch a list of nodes.', className: 'api-method patch', }, { type: 'doc', - id: 'reference/api/create-a-new-node-under-the-given-parent-node', + id: 'version-4.X/reference/api/create-a-new-node-under-the-given-parent-node', label: 'Create a new node under the given parent node', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/get-a-node-with-the-given-node-id', + id: 'version-4.X/reference/api/get-a-node-with-the-given-node-id', label: 'Get a node with the given node id', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/update-a-node-with-the-given-node-id', + id: 'version-4.X/reference/api/update-a-node-with-the-given-node-id', label: 'Update a node with the given node id', className: 'api-method patch', }, { type: 'doc', - id: 'reference/api/delete-a-node-with-the-given-node-id', + id: 'version-4.X/reference/api/delete-a-node-with-the-given-node-id', label: 'Delete a node with the given node id.', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/patch-a-node-with-the-given-node-id-in-given-section', + id: 'version-4.X/reference/api/patch-a-node-with-the-given-node-id-in-given-section', label: 'Patch a node with the given node id in given section', className: 'api-method patch', }, @@ -212,24 +205,24 @@ const sidebar: SidebarsConfig = { label: 'model', link: { type: 'doc', - id: 'reference/api/model', + id: 'version-4.X/reference/api/model', }, items: [ { type: 'doc', - id: 'reference/api/get-the-currently-defined-model', + id: 'version-4.X/reference/api/get-the-currently-defined-model', label: 'Get the currently defined model.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/add-or-update-the-current-defined-model', + id: 'version-4.X/reference/api/add-or-update-the-current-defined-model', label: 'Add or update the current defined model.', className: 'api-method patch', }, { type: 'doc', - id: 'reference/api/get-the-currently-defined-model-as-svg-uml-image', + id: 'version-4.X/reference/api/get-the-currently-defined-model-as-svg-uml-image', label: 'Get the currently defined model as svg uml image.', className: 'api-method get', }, @@ -240,36 +233,36 @@ const sidebar: SidebarsConfig = { label: 'config', link: { type: 'doc', - id: 'reference/api/config', + id: 'version-4.X/reference/api/config', }, items: [ { type: 'doc', - id: 'reference/api/get-all-configuration-keys', + id: 'version-4.X/reference/api/get-all-configuration-keys', label: 'Get all configuration keys', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-a-configuration-by-its-id', + id: 'version-4.X/reference/api/get-a-configuration-by-its-id', label: 'Get a configuration by its id', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/replace-a-configuration-with-given-id', + id: 'version-4.X/reference/api/replace-a-configuration-with-given-id', label: 'Replace a configuration with given id', className: 'api-method put', }, { type: 'doc', - id: 'reference/api/patch-a-configuration-by-its-id', + id: 'version-4.X/reference/api/patch-a-configuration-by-its-id', label: 'Patch a configuration by its id', className: 'api-method patch', }, { type: 'doc', - id: 'reference/api/delete-a-configuration-by-its-id', + id: 'version-4.X/reference/api/delete-a-configuration-by-its-id', label: 'Delete a configuration by its id', className: 'api-method delete', }, @@ -280,36 +273,36 @@ const sidebar: SidebarsConfig = { label: 'config_validation', link: { type: 'doc', - id: 'reference/api/config-validation', + id: 'version-4.X/reference/api/config-validation', }, items: [ { type: 'doc', - id: 'reference/api/get-the-currently-defined-configuration-model', + id: 'version-4.X/reference/api/get-the-currently-defined-configuration-model', label: 'Get the currently defined configuration model.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/add-or-update-the-current-defined-configuration-model', + id: 'version-4.X/reference/api/add-or-update-the-current-defined-configuration-model', label: 'Add or update the current defined configuration model.', className: 'api-method patch', }, { type: 'doc', - id: 'reference/api/get-all-configuration-keys-that-have-a-model-defined', + id: 'version-4.X/reference/api/get-all-configuration-keys-that-have-a-model-defined', label: 'Get all configuration keys that have a model defined.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-a-configuration-validation-by-its-id', + id: 'version-4.X/reference/api/get-a-configuration-validation-by-its-id', label: 'Get a configuration validation by its id', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/replace-a-configuration-validation-with-given-id', + id: 'version-4.X/reference/api/replace-a-configuration-validation-with-given-id', label: 'Replace a configuration validation with given id', className: 'api-method put', }, @@ -320,24 +313,24 @@ const sidebar: SidebarsConfig = { label: 'cli', link: { type: 'doc', - id: 'reference/api/cli', + id: 'version-4.X/reference/api/cli', }, items: [ { type: 'doc', - id: 'reference/api/evaluate-a-cli-command', + id: 'version-4.X/reference/api/evaluate-a-cli-command', label: 'Evaluate a cli command', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/execute-a-cli-command', + id: 'version-4.X/reference/api/execute-a-cli-command', label: 'Execute a cli command', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/get-information-about-cli', + id: 'version-4.X/reference/api/get-information-about-cli', label: 'Get information about CLI', className: 'api-method get', }, @@ -348,54 +341,54 @@ const sidebar: SidebarsConfig = { label: 'subscriptions', link: { type: 'doc', - id: 'reference/api/subscriptions', + id: 'version-4.X/reference/api/subscriptions', }, items: [ { type: 'doc', - id: 'reference/api/list-all-subscriptions', + id: 'version-4.X/reference/api/list-all-subscriptions', label: 'List all subscriptions', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/list-all-subscribers-for-a-given-event-type', + id: 'version-4.X/reference/api/list-all-subscribers-for-a-given-event-type', label: 'List all subscribers for a given event type', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-subscriber-by-id', + id: 'version-4.X/reference/api/get-subscriber-by-id', label: 'Get subscriber by id', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/define-subscriber-with-all-subscriptions', + id: 'version-4.X/reference/api/define-subscriber-with-all-subscriptions', label: 'Define subscriber with all subscriptions', className: 'api-method put', }, { type: 'doc', - id: 'reference/api/delete-by-id', + id: 'version-4.X/reference/api/delete-by-id', label: 'Delete by id', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/add-subscription-to-subscriber', + id: 'version-4.X/reference/api/add-subscription-to-subscriber', label: 'Add subscription to subscriber', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/delete-a-specific-subscription-from-the-subscriber', + id: 'version-4.X/reference/api/delete-a-specific-subscription-from-the-subscriber', label: 'Delete a specific subscription from the subscriber.', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/web-socket-listen-to-registered-events-of-given-subscriber', + id: 'version-4.X/reference/api/web-socket-listen-to-registered-events-of-given-subscriber', label: '[WebSocket] Listen to registered events of given subscriber', className: 'api-method get', }, @@ -406,18 +399,18 @@ const sidebar: SidebarsConfig = { label: 'work_queue', link: { type: 'doc', - id: 'reference/api/work-queue', + id: 'version-4.X/reference/api/work-queue', }, items: [ { type: 'doc', - id: 'reference/api/web-socket-attach-to-the-working-queue', + id: 'version-4.X/reference/api/web-socket-attach-to-the-working-queue', label: '[WebSocket] Attach to the working queue', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/list-all-outstanding-work-items', + id: 'version-4.X/reference/api/list-all-outstanding-work-items', label: 'List all outstanding work items', className: 'api-method get', }, @@ -428,18 +421,18 @@ const sidebar: SidebarsConfig = { label: 'certificate', link: { type: 'doc', - id: 'reference/api/certificate', + id: 'version-4.X/reference/api/certificate', }, items: [ { type: 'doc', - id: 'reference/api/retrieve-the-certificate-authorities-public-certificate', + id: 'version-4.X/reference/api/retrieve-the-certificate-authorities-public-certificate', label: 'Retrieve the certificate authorities public certificate.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/sign-a-certificate-request', + id: 'version-4.X/reference/api/sign-a-certificate-request', label: 'Sign a certificate request.', className: 'api-method post', }, @@ -450,72 +443,72 @@ const sidebar: SidebarsConfig = { label: 'report', link: { type: 'doc', - id: 'reference/api/report', + id: 'version-4.X/reference/api/report', }, items: [ { type: 'doc', - id: 'reference/api/list-all-checks', + id: 'version-4.X/reference/api/list-all-checks', label: 'List all checks.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-a-check-by-its-id', + id: 'version-4.X/reference/api/get-a-check-by-its-id', label: 'Get a check by its id.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/create-or-replace-a-check-by-its-id', + id: 'version-4.X/reference/api/create-or-replace-a-check-by-its-id', label: 'Create or replace a check by its id.', className: 'api-method put', }, { type: 'doc', - id: 'reference/api/delete-a-check-by-its-id', + id: 'version-4.X/reference/api/delete-a-check-by-its-id', label: 'Delete a check by its id.', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/list-available-benchmarks', + id: 'version-4.X/reference/api/list-available-benchmarks', label: 'List available benchmarks.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/get-a-benchmark-by-its-id', + id: 'version-4.X/reference/api/get-a-benchmark-by-its-id', label: 'Get a benchmark by its id.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/create-or-replace-a-benchmark-by-its-id', + id: 'version-4.X/reference/api/create-or-replace-a-benchmark-by-its-id', label: 'Create or replace a benchmark by its id.', className: 'api-method put', }, { type: 'doc', - id: 'reference/api/delete-a-benchmark-by-its-id', + id: 'version-4.X/reference/api/delete-a-benchmark-by-its-id', label: 'Delete a benchmark by its id.', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/perform-a-benchmark-on-a-graph', + id: 'version-4.X/reference/api/perform-a-benchmark-on-a-graph', label: 'Perform a benchmark on a graph.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/list-all-resources-that-match-a-given-check', + id: 'version-4.X/reference/api/list-all-resources-that-match-a-given-check', label: 'List all resources that match a given check.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph', + id: 'version-4.X/reference/api/perform-a-dynamically-assembled-benchmark-on-a-graph', label: 'Perform a dynamically assembled benchmark on a graph.', className: 'api-method get', }, @@ -526,32 +519,32 @@ const sidebar: SidebarsConfig = { label: 'system', link: { type: 'doc', - id: 'reference/api/system', + id: 'version-4.X/reference/api/system', }, items: [ { type: 'doc', - id: 'reference/api/send-analytics-events-to-the-server', + id: 'version-4.X/reference/api/send-analytics-events-to-the-server', label: 'Send analytics events to the server', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/web-socket-register-as-event-listener-and-receive-all-events', + id: 'version-4.X/reference/api/web-socket-register-as-event-listener-and-receive-all-events', label: '[WebSocket] Register as event listener and receive all events.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic', + id: 'version-4.X/reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic', label: 'This endpoint signals if the system is ready to serve traffic.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/send-a-ping-to-the-system-and-expect-a-pong', + id: 'version-4.X/reference/api/send-a-ping-to-the-system-and-expect-a-pong', label: 'Send a ping to the system and expect a pong.', className: 'api-method get', }, @@ -562,12 +555,12 @@ const sidebar: SidebarsConfig = { label: 'debug', link: { type: 'doc', - id: 'reference/api/debug', + id: 'version-4.X/reference/api/debug', }, items: [ { type: 'doc', - id: 'reference/api/transform-the-search-into-the-raw-database-search', + id: 'version-4.X/reference/api/transform-the-search-into-the-raw-database-search', label: 'Transform the search into the raw database search', className: 'api-method post', }, @@ -578,12 +571,12 @@ const sidebar: SidebarsConfig = { label: 'timeseries', link: { type: 'doc', - id: 'reference/api/timeseries', + id: 'version-4.X/reference/api/timeseries', }, items: [ { type: 'doc', - id: 'reference/api/load-time-series-data', + id: 'version-4.X/reference/api/load-time-series-data', label: 'Load time series data.', className: 'api-method post', }, @@ -594,36 +587,36 @@ const sidebar: SidebarsConfig = { label: 'tsdb', link: { type: 'doc', - id: 'reference/api/tsdb', + id: 'version-4.X/reference/api/tsdb', }, items: [ { type: 'doc', - id: 'reference/api/proxy-request-to-a-configured-tsdb-server', + id: 'version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server', label: 'Proxy request to a configured tsdb server.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/proxy-request-to-a-configured-tsdb-server', + id: 'version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server', label: 'Proxy request to a configured tsdb server.', className: 'api-method put', }, { type: 'doc', - id: 'reference/api/proxy-request-to-a-configured-tsdb-server', + id: 'version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server', label: 'Proxy request to a configured tsdb server.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/proxy-request-to-a-configured-tsdb-server', + id: 'version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server', label: 'Proxy request to a configured tsdb server.', className: 'api-method delete', }, { type: 'doc', - id: 'reference/api/proxy-request-to-a-configured-tsdb-server', + id: 'version-4.X/reference/api/proxy-request-to-a-configured-tsdb-server', label: 'Proxy request to a configured tsdb server.', className: 'api-method patch', }, @@ -634,42 +627,42 @@ const sidebar: SidebarsConfig = { label: 'authorization', link: { type: 'doc', - id: 'reference/api/authorization', + id: 'version-4.X/reference/api/authorization', }, items: [ { type: 'doc', - id: 'reference/api/get-the-public-keys-of-the-configured-jwt-issuer', + id: 'version-4.X/reference/api/get-the-public-keys-of-the-configured-jwt-issuer', label: 'Get the public keys of the configured JWT issuer.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/this-endpoint-is-used-to-login-the-user', + id: 'version-4.X/reference/api/this-endpoint-is-used-to-login-the-user', label: 'This endpoint is used to login the user.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/this-endpoint-is-used-to-create-the-first-user', + id: 'version-4.X/reference/api/this-endpoint-is-used-to-create-the-first-user', label: 'This endpoint is used to create the first user.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/this-endpoint-is-used-to-authenticate-the-user', + id: 'version-4.X/reference/api/this-endpoint-is-used-to-authenticate-the-user', label: 'This endpoint is used to authenticate the user.', className: 'api-method post', }, { type: 'doc', - id: 'reference/api/this-endpoint-is-used-to-get-the-user-information', + id: 'version-4.X/reference/api/this-endpoint-is-used-to-get-the-user-information', label: 'This endpoint is used to get the user information.', className: 'api-method get', }, { type: 'doc', - id: 'reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire', + id: 'version-4.X/reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire', label: 'This endpoint is used to renew a JWT that is about to expire.', className: 'api-method get', diff --git a/versioned_docs/version-4.X/reference/api/sign-a-certificate-request.api.mdx b/versioned_docs/version-4.X/reference/api/sign-a-certificate-request.api.mdx index 1b602c14..58172c88 100644 --- a/versioned_docs/version-4.X/reference/api/sign-a-certificate-request.api.mdx +++ b/versioned_docs/version-4.X/reference/api/sign-a-certificate-request.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["certificate"],"requestBody":{"description":"The certificate signing request (csr) in pkcs10 format.","content":{"application/pkcs10":{"schema":{"type":"string","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIICYDCCAUgCAQAwGzEZMBcGA1UEAwwQc29tZS5lbmdpbmVlcmluZzCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM6QVB0C0G1yJRD1aWye8a1IscJa4cN4\n+PDWim+2qemCRpiIafgsict5AtlqmvDaYYs7uaLI8PLASMz0pnrxLaVbRVu5H7Ix\nKSh1Vz/WjsqTDNw5Q+qPpT/YPP5l02IrKrP/pdMNC0FYnDxr6Y4bXVuFqtMv+Zr2\namJSIpOET2wswo6MRflfiO9jh8mD5mdU+SqDHAvBpU7H3L4rd3cWyVsz3Q4cqpwa\nSDayhRMewxusI2MTj/uNEzZYTWiHb2TXUkYYSMYazdbVRUKFNWOsq+z1RPV1IUUe\ng0yjNS+tfYF0numPzwt9GNuB18O3X1G5rs2nHDRQL8pAbcy5Wjsuwf0CAwEAAaAA\nMA0GCSqGSIb3DQEBCwUAA4IBAQAuI5ijV9ahWtRhondwOYuYFMZL+i+tXPdn+O/B\nV7WFVdbaV13TpJ3giJBhCY3mlQ+Vb7BNDhgqdcsiXr4M1fDC0gf8J/GYA2s4yvrf\nfCqnFA97UET0AwpIA22+JZnZVs+FXqDsU2VMBgmGToU0QgzBSVi8/exSx3CWBgAk\nx2q98/r/Dhbi2KQkOYJ7yQx1t0416UiFB9xUnDIreg0k5chP5NF1YRbsatParYhG\nOviEEbELaTnWbmfnveBWjxAImv5w3tkF/dapH+QQ5yTIzDEl/UoG2pXC6QGRaRsp\nMft1XSBtZDykb6SrTTz/lUfjn3XX+zqQ7g466HvglAwqUfX1\n-----END CERTIFICATE REQUEST-----\n"}}}},"responses":{"200":{"description":"The certificate in PEM format.","content":{"application/x-pem-file":{"schema":{"type":"string","example":"-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIUEtDMkiSa2FYM5LVhZiPlspro39owDQYJKoZIhvcNAQEL\nBQAweDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcM\nDVNhbiBGcmFuY2lzY28xHjAcBgNVBAoMFVNvbWUgRW5naW5lZXJpbmcgSW5jLjEc\nMBoGA1UEAwwTQ2xvdWRrZWVwZXIgUm9vdCBDQTAeFw0yMTEyMjIwOTQ1NDJaFw0y\nMjEyMjIwOTQ1NDJaMBsxGTAXBgNVBAMMEHNvbWUuZW5naW5lZXJpbmcwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5VIgOTR95jIxWJZHXUo6FUv4CyDn/\nfZWxZQmFXC8c6SqspRNpXMgZq+riTm+yQ1l/kc2xVpr5S8tVeFGGjzaCcf51DMSx\nj7SaUXP2oDtMi7e9wkfTaoN3z3erVwJl39znKQviEL8G7vYPCn7oDqt1HHry7ctN\ncrEMWYSQXUYe4s++K1q65VyGNBp6AcIrmefoH0pGARZs4MbvR74U44xsj25VFS+W\nM3YSomBv4oB4QkqlcVWOU/Tlx7Tq7ASfkSqEkUigKMx/QKrdeQHxCkEtmjbiHhOk\nVaCYsVbi8pVvE5URNrycvzJXGdimSL8pVZ8M89gUDoxUoiAneSswoRZrAgMBAAGj\nMTAvMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUH\nAwIwDQYJKoZIhvcNAQELBQADggEBAA70yqOYfYtguJKji+IeIsZflNH2DH6lZ2Xe\nmv5suRbjuKEApSDUL59rpliT1dAcX6+cfKDQjzZ/7VWmp+XZmehGRlhRNWJMzsOz\nXv8/5l0LL59yN4w4FNq2cREcLj35RVYUU7lssNr/RNE9xNMHeqLdC4oW22PUi1lY\niq212G5yQTg31lVmzA9Uzvz+p/A8CG24tSBFbydSIogprmALS+5rnso0bWJ3Owf1\nCVz6Dc9UM4kBWDsb+iTffXwbgSDbG+lJ+9TEndcAzb7Zxs6ghMtv/PKR/tmw+O32\n3da9fAZE2eZoDvssH6LAUcFjtP9SFb8ZOdHJ15l279vzgCvWsvU=\n-----END CERTIFICATE-----\n"}}}}},"description":"Sign a certificate request.","method":"post","path":"/ca/sign","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Sign a certificate request.","description":{"type":"text/plain"},"url":{"path":["ca","sign"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/pkcs10"},{"key":"Accept","value":"application/x-pem-file"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-authenticate-the-user.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-authenticate-the-user.api.mdx index 03dcc3a2..96e28e3b 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-authenticate-the-user.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-authenticate-the-user.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"Authenticate the user. This endpoint needs to be accessed from a browser! It is possible that the user is redirected to another authentication server.","tags":["authorization"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email of the user."},"password":{"type":"string","description":"The password of the user."},"redirect":{"type":"string","description":"The redirect url after the user is created."}}}}}},"responses":{"303":{"description":"The redirect to the specified url in the form with a code parameter added."}},"method":"post","path":"/authenticate","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint is used to authenticate the user.","description":{"content":"Authenticate the user. This endpoint needs to be accessed from a browser! It is possible that the user is redirected to another authentication server.","type":"text/plain"},"url":{"path":["authenticate"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"method":"POST","body":{"mode":"urlencoded","urlencoded":[]}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-create-the-first-user.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-create-the-first-user.api.mdx index 56c317f7..ef28ac5b 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-create-the-first-user.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-create-the-first-user.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["authorization"],"description":"Create the first user from the create first user login form.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"company":{"type":"string","description":"The company name."},"fullname":{"type":"string","description":"The full name of the user."},"email":{"type":"string","description":"The email of the user."},"password":{"type":"string","description":"The password of the user."},"password_repeat":{"type":"string","description":"The repeated password of the user."},"redirect":{"type":"string","description":"The redirect url after the user is created."}}}}}},"responses":{"303":{"description":"The redirect to the specified url in the form."}},"method":"post","path":"/create-first-user","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint is used to create the first user.","description":{"content":"Create the first user from the create first user login form.","type":"text/plain"},"url":{"path":["create-first-user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"method":"POST","body":{"mode":"urlencoded","urlencoded":[]}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-get-the-user-information.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-get-the-user-information.api.mdx index 1078ee10..8acd7472 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-get-the-user-information.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-get-the-user-information.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["authorization"],"description":"Get the user information.","responses":{"200":{"description":"The user information.","content":{"application/json":{"example":"{\n \"email\": \"test@test.de\",\n \"exp\": 1683660989,\n \"roles\": \"admin\"\n}\n"}}}},"method":"get","path":"/authorization/user","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint is used to get the user information.","description":{"content":"Get the user information.","type":"text/plain"},"url":{"path":["authorization","user"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-login-the-user.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-login-the-user.api.mdx index 77af6d0b..1fdea5ef 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-login-the-user.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-login-the-user.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["authorization"],"description":"Authenticate the user. This endpoint needs to be accessed from a browser! It is possible that the user is redirected to another authentication server.","responses":{"200":{"description":"The login page."}},"method":"get","path":"/login","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint is used to login the user.","description":{"content":"Authenticate the user. This endpoint needs to be accessed from a browser! It is possible that the user is redirected to another authentication server.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire.api.mdx index e775ab81..b3ee01f7 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-is-used-to-renew-a-jwt-that-is-about-to-expire.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["authorization"],"description":"Get the user information.","responses":{"200":{"description":"The user information.","headers":{"Authorization":{"description":"The authorization header with the renewed JWT.","schema":{"type":"string"}}},"content":{"application/json":{"example":"{\n \"email\": \"test@test.de\",\n \"exp\": 1683665359,\n \"roles\": \"admin\"\n}\n"}}}},"method":"get","path":"/authorization/renew","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint is used to renew a JWT that is about to expire.","description":{"content":"Get the user information.","type":"text/plain"},"url":{"path":["authorization","renew"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic.api.mdx b/versioned_docs/version-4.X/reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic.api.mdx index 8477d288..b7830cca 100644 --- a/versioned_docs/version-4.X/reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic.api.mdx +++ b/versioned_docs/version-4.X/reference/api/this-endpoint-signals-if-the-system-is-ready-to-serve-traffic.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["system"],"responses":{"200":{"description":"This response code signals, that the system is ready.","content":{"text/plain":{"schema":{"type":"string","example":"200: OK"}}}}},"description":"This endpoint signals if the system is ready to serve traffic.","method":"get","path":"/system/ready","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"This endpoint signals if the system is ready to serve traffic.","description":{"type":"text/plain"},"url":{"path":["system","ready"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/transform-the-search-into-the-raw-database-search.api.mdx b/versioned_docs/version-4.X/reference/api/transform-the-search-into-the-raw-database-search.api.mdx index c8c27a78..49ab8203 100644 --- a/versioned_docs/version-4.X/reference/api/transform-the-search-into-the-raw-database-search.api.mdx +++ b/versioned_docs/version-4.X/reference/api/transform-the-search-into-the-raw-database-search.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nShow the underlying raw search.\n","tags":["debug"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"section","in":"query","description":"The name of the section used for all property paths. If not defined root is assumed.","required":false,"schema":{"type":"string","enum":["reported","desired","metadata"]}},{"name":"at","in":"query","description":"The timestamp to use for the search. If not defined the latest version of the graph is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"description":"The search to perform","content":{"text/plain":{"schema":{"type":"string","example":"is(graph_root) and reported.name==\"root\" -->"}}}},"responses":{"200":{"description":"Returns the search as performed by the database.","content":{"application/json":{"schema":{"type":"object","description":"The raw query as performed by the database","properties":{"query":{"type":"string","description":"The string representation of the query"},"bind_vars":{"type":"object","description":"All binding variables for this query","additionalProperties":true}},"title":"RawQuery"}}}}},"method":"post","path":"/graph/{graph_id}/search/raw","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Transform the search into the raw database search","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nShow the underlying raw search.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","search","raw"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of the section used for all property paths. If not defined root is assumed.","type":"text/plain"},"key":"section","value":""},{"disabled":false,"description":{"content":"The timestamp to use for the search. If not defined the latest version of the graph is used.","type":"text/plain"},"key":"at","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":""}}} sidebar_class_name: "post api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/update-a-node-with-the-given-node-id.api.mdx b/versioned_docs/version-4.X/reference/api/update-a-node-with-the-given-node-id.api.mdx index 0e128a39..f5387ef4 100644 --- a/versioned_docs/version-4.X/reference/api/update-a-node-with-the-given-node-id.api.mdx +++ b/versioned_docs/version-4.X/reference/api/update-a-node-with-the-given-node-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"**Experimental**: This API is not stable and might be subject of change.
\nUpdate a node with the given node id\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The partial object data to patch.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"Return the patched node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"patch","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Update a node with the given node id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.
\nUpdate a node with the given node id\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/web-socket-attach-to-the-working-queue.api.mdx b/versioned_docs/version-4.X/reference/api/web-socket-attach-to-the-working-queue.api.mdx index 6d69c8a7..404d3471 100644 --- a/versioned_docs/version-4.X/reference/api/web-socket-attach-to-the-working-queue.api.mdx +++ b/versioned_docs/version-4.X/reference/api/web-socket-attach-to-the-working-queue.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\nThis endpoint is used by worker nodes which can perform work.\nA worker would use this endpoint to establish a websocket connection and register the tasks\nthat can be performed by the worker. One worker can perform one or more tasks over one connection.\n\nIn case the connection is lost, all outstanding tasks are rescheduled to other workers.\nThis means the local tasks queue should be wiped in case of connection loss.\n\nNote: the server tries to spread the number of tasks evenly over the number of workers.\nThis number is derived by the number of outstanding messages in the queue irrelevant which tasks\nare outstanding.\n","parameters":[{"name":"task","description":"The name of all tasks that this worker is able to perform.","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter","description":"Additional properties to filter tasks of provided task name.\nThe value of the parameter is either a string or a list of strings separated by comma.\nThe available filter criteria are defined by the specific task to execute.\n\nAll specified filter criteria need to match by the task to execute.\nIf a list of values is defined for a filter criteria, at least one needs to match.\n(e.g. cloud=aws,gcp would match a task for cloud=aws).\n\nExample:\n The worker is able to perform tasks of type tag, but only for cloud AWS:\n cloud=aws\n\n The worker is able to perform tasks of type tag, for AWS and GCP:\n cloud=aws,gcp\n\n Maybe the worker is only capable to perform the work in a specific account.\n cloud=aws&account=123 could be specified to only filter for tasks in this cloud in this\n account.\n\nIn case there are multiple workers that match the task criteria, the most specific\nworker is taken.\n\nExample:\n worker1: cloud=aws,gcp\n worker2: cloud=aws account=123\n\nIf the task is for cloud=aws and account=123, then only worker2 would get the task to execute\nnot worker1.\n","in":"query","required":false,"schema":{"type":"object","additionalProperties":true,"example":{"cloud":"aws","account":"123,124,125"}}}],"tags":["work_queue"],"responses":{"200":{"description":"When the connection is established.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}},"method":"get","path":"/work/queue","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"[WebSocket] Attach to the working queue","description":{"content":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\nThis endpoint is used by worker nodes which can perform work.\nA worker would use this endpoint to establish a websocket connection and register the tasks\nthat can be performed by the worker. One worker can perform one or more tasks over one connection.\n\nIn case the connection is lost, all outstanding tasks are rescheduled to other workers.\nThis means the local tasks queue should be wiped in case of connection loss.\n\nNote: the server tries to spread the number of tasks evenly over the number of workers.\nThis number is derived by the number of outstanding messages in the queue irrelevant which tasks\nare outstanding.\n","type":"text/plain"},"url":{"path":["work","queue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The name of all tasks that this worker is able to perform.","type":"text/plain"},"key":"task","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/web-socket-listen-to-registered-events-of-given-subscriber.api.mdx b/versioned_docs/version-4.X/reference/api/web-socket-listen-to-registered-events-of-given-subscriber.api.mdx index e9dbd28f..738b5c53 100644 --- a/versioned_docs/version-4.X/reference/api/web-socket-listen-to-registered-events-of-given-subscriber.api.mdx +++ b/versioned_docs/version-4.X/reference/api/web-socket-listen-to-registered-events-of-given-subscriber.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\nThe connection to this endpoint will never be closed.\nAll action events of the system this subscriber has registerd will be send to this\nconnection.\n","tags":["subscriptions"],"parameters":[{"name":"subscriber_id","in":"path","description":"The identifier of the subscriber","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"No subscriber found","content":{"text/plain":{"schema":{"type":"string","example":"No subscriber with this id"}}}}},"method":"get","path":"/subscriber/{subscriber_id}/handle","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"[WebSocket] Listen to registered events of given subscriber","description":{"content":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\nThe connection to this endpoint will never be closed.\nAll action events of the system this subscriber has registerd will be send to this\nconnection.\n","type":"text/plain"},"url":{"path":["subscriber",":subscriber_id","handle"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the subscriber","type":"text/plain"},"type":"any","value":"","key":"subscriber_id"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true --- diff --git a/versioned_docs/version-4.X/reference/api/web-socket-register-as-event-listener-and-receive-all-events.api.mdx b/versioned_docs/version-4.X/reference/api/web-socket-register-as-event-listener-and-receive-all-events.api.mdx index d394b5a6..82922514 100644 --- a/versioned_docs/version-4.X/reference/api/web-socket-register-as-event-listener-and-receive-all-events.api.mdx +++ b/versioned_docs/version-4.X/reference/api/web-socket-register-as-event-listener-and-receive-all-events.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"description":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\n## Authorization\nIn case Fix has a PSK infrastructure in place, the client needs to send a JWT token via the `Authorization` header\nor via the `fix_authorization` cookie.\nIt is also possible to omit header or cookie and send an Authorization message as first message on the websocket.\nExample\n{ \"kind\": \"authorization\", \"jwt\": \"Bearer \" }\n","parameters":[{"name":"show","in":"query","description":"All events to show as a comma separated list","required":false,"explode":false,"schema":{"type":"string"}}],"tags":["system"],"responses":{"default":{"description":""}},"method":"get","path":"/events","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"[WebSocket] Register as event listener and receive all events.","description":{"content":"## WebSocket Endpoint\nThe client needs to send all the required headers for a ws connection\nand has to handle the websocket protocol.
\n**Note this can not be tested from within swagger!**\n\n## Authorization\nIn case Fix has a PSK infrastructure in place, the client needs to send a JWT token via the `Authorization` header\nor via the `fix_authorization` cookie.\nIt is also possible to omit header or cookie and send an Authorization message as first message on the websocket.\nExample\n{ \"kind\": \"authorization\", \"jwt\": \"Bearer \" }\n","type":"text/plain"},"url":{"path":["events"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"All events to show as a comma separated list","type":"text/plain"},"key":"show","value":""}],"variable":[]},"method":"GET"}} sidebar_class_name: "get api-method" -info_path: reference/api/fix-inventory-core-rest-api +info_path: version-4.X/reference/api/fix-inventory-core-rest-api custom_edit_url: null hide_send_button: true ---