Endor ReST API (1.0)
Download OpenAPI specification:
UpdateAgentConfig
Updates a specified AgentConfig.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}
}
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
ListAgentConfigs
Lists all AgentConfings visible in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- null
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAgentConfig
Creates an AgentConfig.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
null
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
GetAgentConfig
Fetches an AgentConfig specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
DeleteAgentConfig
Deletes an AgentConfig specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateAgentSession
Updates a specified AgentSession.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}
}
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
ListAgentSessions
Lists all AgentSessions visible in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- null
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAgentSession
Creates an AgentSession.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
null
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
GetAgentSession
Fetches an AgentSession specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- default
{- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
DeleteAgentSession
Deletes an AgentSession specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateAIQuery
Queries metrics for specific values. It returns back a text response.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant metadata restricts access to a specific tenant.) The tenant metadata restricts access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1AIQuerySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "input_prompt": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "input_prompt": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "output_text": "string",
- "packages": [
- {
- "name": "string",
- "description": "string",
- "repository": "string",
- "latest_version": "string",
- "qualified_name": "string",
- "package_version_uuid": "string"
}
], - "query_type": "QUERY_TYPE_UNSPECIFIED"
}
}
UpdateAnalyticsExecutionRecord
Updates the analytic execution record objects.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Captures the status, time and stats of an execution of the analytics. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListAnalyticsExecutionRecord
Lists all analytics execution records for a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAnalyticsExecutionRecord
Creates an analytics execution record in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Analytic records are associated with a tenant.) Analytic records are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1AnalyticsExecutionRecordSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetAnalyticsExecutionRecord
Fetches the analytics execution records for a specified UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "analytics_time": "2019-08-24T14:15:22Z",
- "analytics_state": "ANALYSIS_STATE_UNSPECIFIED",
- "execution_stats": { },
- "project_name": "string",
- "version_name": "string",
- "project_uuid": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
CreateAPIKeyReq
Validates an API key.
Request Body schema: application/jsonrequired
Validates an API key.
key required | string The unique identifier of the API key. |
secret required | string The secret associated with the provided API Key. |
object (v1User) User represents a user in the system. Mostly includes configuration parameters that are user wise. |
Responses
Request samples
- Payload
{- "key": "string",
- "secret": "string",
- "issuing_user": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}
Response samples
- 200
- default
{- "key": "string",
- "secret": "string",
- "valid": true,
- "issuing_user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}
ListAPIKeys
Lists all API keys for a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "key": "string",
- "secret": "string",
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z",
- "issuing_user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- null
]
}, - "property2": {
- "event": [
- null
]
}
}, - "token_hash": "string"
}
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAPIKey
Creates an API key.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (APIKeys are namespaced objects.) APIKeys are namespaced objects. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1APIKeySpec) | |
propagate | boolean Indicates whether the API key can be used for the child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z",
- "issuing_user": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "key": "string",
- "secret": "string",
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z",
- "issuing_user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}, - "propagate": true
}
GetAPIKey
Fetches the API key dentified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "key": "string",
- "secret": "string",
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z",
- "issuing_user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}, - "propagate": true
}
DeleteAPIKey
Deletes the API key specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListApproveServiceRequests
Lists all approve service requests in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "service_request_uuid": "string",
- "comment": "string",
- "status": "REQUEST_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateApproveServiceRequest
Creates an approve service request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (ApproveServiceRequest are raised on a specific internal tenant.) ApproveServiceRequest are raised on a specific internal tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ApproveServiceRequestSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "service_request_uuid": "string",
- "comment": "string",
- "status": "REQUEST_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "service_request_uuid": "string",
- "comment": "string",
- "status": "REQUEST_STATUS_UNSPECIFIED"
}
}
GetApproveServiceRequest
Fetches an approve service request specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "service_request_uuid": "string",
- "comment": "string",
- "status": "REQUEST_STATUS_UNSPECIFIED"
}
}
DeleteApproveServiceRequest
Deletes an approve service request specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListArtifactLogs
Returns a list of artifact logs based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "assured_package_version_name": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateArtifactLog
Creates a artifact log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the artifact log.) Namespace of the artifact log. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ArtifactLogSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "assured_package_version_name": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "assured_package_version_name": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
GetArtifactLog
Returns a specified artifact log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "assured_package_version_name": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
DeleteArtifactLog
Deletes a artifact log specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateArtifactOperation
Services the artifact operations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant metadata restrict access to a specific tenant.) The tenant metadata restrict access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1ArtifactOperationSpec) | |
object (v1ArtifactOperationResponse) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "command": "ARTIFACT_OPERATION_COMMAND_UNSPECIFIED",
- "artifact_name": "string",
- "digest": "string",
- "extensions": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED"
}, - "response": {
- "result": "ARTIFACT_OPERATION_RESULT_UNSPECIFIED",
- "artifact_signature": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "command": "ARTIFACT_OPERATION_COMMAND_UNSPECIFIED",
- "artifact_name": "string",
- "digest": "string",
- "extensions": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED"
}, - "response": {
- "result": "ARTIFACT_OPERATION_RESULT_UNSPECIFIED",
- "artifact_signature": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
}
}
UpdateArtifactSignature
Updates the artifact signature.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents an artifact signature object. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
ListArtifactSignatures
Lists all artifact signatures.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateArtifactSignature
Creates a new artifact signature.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Tenant metadata required for artifact signature requests.) Tenant metadata required for artifact signature requests. |
required | object (v1ArtifactSignatureSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
GetArtifactSignature
Fetches an artifact signature identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate": "string",
- "signature": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "simple_container_image": {
- "critical": {
- "type": "string",
- "identity": {
- "docker_reference": "string"
}, - "image": {
- "docker_manifest_image": "string",
- "docker_manifest_digest": "string"
}
}
}, - "revoked": true,
- "artifact_type": "ARTIFACT_TYPE_UNSPECIFIED",
- "artifact_digest": "string",
- "source_repository_ref": "string",
- "provenance": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}, - "artifact_name": "string"
}
}
UpdateAssuredPackageVersion
Updates a specified assured package version.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object AssuredPackageVersion is a package version that have been built, tested, and patched by Endor Labs. It includes details on how the version was built, tested, and patched, as well as information on the vulnerabilities that have been addressed through the patches. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "build_attestation": {
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": "COMMIT_TYPE_UNSPECIFIED",
- "author": "string",
- "message": "string",
- "commit_date": "2019-08-24T14:15:22Z",
- "sha": "string",
- "commit_url": "string"
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": "string",
- "aliases": [
- "string"
], - "uuid": "string"
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- null
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- null
], - "related": [
- null
], - "cvss_v3_severity": {
- "score": null,
- "vector": null,
- "level": null,
- "temporal_score": null,
- "temporal_vector": null,
- "temporal_level": null
}, - "credits": [
- null
], - "database_specific": { },
- "summary": "string",
- "affected": [
- null
], - "references": [
- null
], - "epss_score": {
- "probability_score": null,
- "percentile_score": null
}, - "raw": {
- "osv_vulnerability": null,
- "endor_vulnerability": null,
- "epss_record": null,
- "nvd_vulnerability": null,
- "kev_record": null
}, - "malicious": true,
- "additional_endor_notes": [
- null
]
}
}
]
}, - "property2": {
- "vulns": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- null
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- null
], - "related": [
- null
], - "cvss_v3_severity": {
- "score": null,
- "vector": null,
- "level": null,
- "temporal_score": null,
- "temporal_vector": null,
- "temporal_level": null
}, - "credits": [
- null
], - "database_specific": { },
- "summary": "string",
- "affected": [
- null
], - "references": [
- null
], - "epss_score": {
- "probability_score": null,
- "percentile_score": null
}, - "raw": {
- "osv_vulnerability": null,
- "endor_vulnerability": null,
- "epss_record": null,
- "nvd_vulnerability": null,
- "kev_record": null
}, - "malicious": true,
- "additional_endor_notes": [
- null
]
}
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "build_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": "COMMIT_TYPE_UNSPECIFIED",
- "author": "string",
- "message": "string",
- "commit_date": "2019-08-24T14:15:22Z",
- "sha": "string",
- "commit_url": "string"
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": "string",
- "aliases": [
- "string"
], - "uuid": "string"
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_url": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_url": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "property2": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListAssuredPackageVersions
Lists all assured package versions in a given namespace
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "build_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": null,
- "author": null,
- "message": null,
- "commit_date": null,
- "sha": null,
- "commit_url": null
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": null,
- "aliases": [ ],
- "uuid": null
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_url": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_url": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null
}
]
}, - "property2": {
- "vulns": [
- {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAssuredPackageVersion
Creates an assured package version in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Git repositories are associated with a tenant.) Git repositories are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1AssuredPackageVersionSpec) |
object (v1ProcessingStatus) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "build_attestation": {
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": "COMMIT_TYPE_UNSPECIFIED",
- "author": "string",
- "message": "string",
- "commit_date": "2019-08-24T14:15:22Z",
- "sha": "string",
- "commit_url": "string"
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": "string",
- "aliases": [
- "string"
], - "uuid": "string"
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "property2": {
- "vulns": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "build_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": "COMMIT_TYPE_UNSPECIFIED",
- "author": "string",
- "message": "string",
- "commit_date": "2019-08-24T14:15:22Z",
- "sha": "string",
- "commit_url": "string"
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": "string",
- "aliases": [
- "string"
], - "uuid": "string"
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_url": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_url": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "property2": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetAssuredPackageVersion
Fetches the assured package version identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "build_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "test_attestation": {
- "are_tests_run": true,
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "security_attestation": {
- "patches": [
- {
- "included_commits": [
- {
- "commit_type": "COMMIT_TYPE_UNSPECIFIED",
- "author": "string",
- "message": "string",
- "commit_date": "2019-08-24T14:15:22Z",
- "sha": "string",
- "commit_url": "string"
}
], - "fix_type": "FIX_TYPE_UNSPECIFIED",
- "fixed_vulns": [
- {
- "name": "string",
- "aliases": [
- "string"
], - "uuid": "string"
}
], - "patch_files": [
- "string"
], - "description": "string"
}
], - "validations": [
- {
- "vulnerability_name": "string",
- "logs_url": "string",
- "logs_upload_content": "string",
- "validated_with_unittest": true
}
]
}, - "deploy_attestation": {
- "logs_url": "string",
- "commands": [
- "string"
], - "logs_upload_content": "string"
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "sha256": "string",
- "reproducible_build_source_code_url": "string",
- "reproducible_build_source_code_upload_content": "string",
- "upgrade_summary": {
- "line_added": 0,
- "line_removed": 0,
- "fixed_vulns": {
- "property1": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "property2": {
- "vulns": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}
}, - "number_of_endor_patches": 0,
- "number_of_original_patches": 0,
- "are_tests_run": true
}, - "version_type": "VERSION_TYPE_UNSPECIFIED"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteAssuredPackageVersion
Deletes an assured package version specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListAuditLogs
List all audit logs in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "message_uuid": "string",
- "message_kind": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "payload": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAuditLog
Creates an audit log for a given object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the message that is accessed.) Namespace of the message that is accessed. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1AuditLogSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "message_uuid": "string",
- "message_kind": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "payload": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "message_uuid": "string",
- "message_kind": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "payload": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
GetAuditLog
Fetches an audit log identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "message_uuid": "string",
- "message_kind": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "payload": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "claims": [
- "string"
], - "remote_address": "string"
}
}
DeleteAuditLog
Deletes an audit log specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
Authenticate
Initiates an authentication request and returns a token along with the token expiration time for an authenticated user.
path Parameters
authentication_source required | string Specifies a user's authentication method, such as "GitHub". |
query Parameters
key | string The API key used for system authentication. Key is required only if the authentication source is "api-key". |
secret | string The API secret used for system authentication. Secret is required only if the authentication source is "api-key". |
Responses
Response samples
- 200
- default
{- "authentication_source": "string",
- "token": "string",
- "expiration_time": "2019-08-24T14:15:22Z",
- "user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}
Logout
Clears the user session and cookies.
path Parameters
authentication_source required | string Specifies a user's authentication method, such as "GitHub". |
query Parameters
key | string The API key used for system authentication. Key is required only if the authentication source is "api-key". |
secret | string The API secret used for system authentication. Secret is required only if the authentication source is "api-key". |
Responses
Response samples
- 200
- default
{- "authentication_source": "string",
- "token": "string",
- "expiration_time": "2019-08-24T14:15:22Z",
- "user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}
ListAuthenticationLogs
Lists all authentication logs in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "success": true,
- "authorized_tenants": [
- "string"
], - "error_message": "string",
- "status": 0,
- "claims": [
- "string"
], - "remote_address": "string",
- "uri": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAuthenticationLog
Creates an authentication log for a given object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the message that is accessed.) Namespace of the message that is accessed. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1AuthenticationLogSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "success": true,
- "authorized_tenants": [
- "string"
], - "error_message": "string",
- "status": 0,
- "claims": [
- "string"
], - "remote_address": "string",
- "uri": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "success": true,
- "authorized_tenants": [
- "string"
], - "error_message": "string",
- "status": 0,
- "claims": [
- "string"
], - "remote_address": "string",
- "uri": "string"
}
}
GetAuthenticationLog
Fetches the authentication log identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "success": true,
- "authorized_tenants": [
- "string"
], - "error_message": "string",
- "status": 0,
- "claims": [
- "string"
], - "remote_address": "string",
- "uri": "string"
}
}
DeleteAuthenticationLog
Deletes the authentication log specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateAuthorizationPolicy
Updates the authorization policy for a given tenant.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents an authorization policy in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
ListAuthorizationPolicies
Lists all authorization policies for a given tenant.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateAuthorizationPolicy
Creates an authorization policy for a given tenant.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Authorization policies are associated with a tenant.) Authorization policies are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1AuthorizationPolicySpec) |
propagate | boolean Indicates that the object should be visible in the child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
GetAuthorizationPolicy
Fetches an authorization policy specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "clause": [
- "string"
], - "target_namespaces": [
- "string"
], - "propagate": true,
- "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "expiration_time": "2019-08-24T14:15:22Z"
}, - "propagate": true
}
DeleteAuthorizationPolicy
Deletes an authorization policy specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateCallGraphData
Updates the metadata of a callgraph.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object CallGraphData represents a call graph data request in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
ListCallGraphData
Lists all call graph data in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateCallGraphData
Creates a call graph. The object must provide a parent ID that is the associated package version that this call graph belongs to. A create operation will replace any previous data and is considered an upsert.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Namespaces are associated with a tenant.) Namespaces are associated with a tenant. |
zstd_bytes | string <byte> Callgraph proto bytes are encoded in zstd bytes. The caller is responsible to compress/uncompress the bytes. |
object (googleprotobufAny)
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++.
Example 2: Pack and unpack a message in Java.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON The JSON representation of an
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
| |
object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
GetCallGraphData
Fetches the call graph for a given package version that is captured in the parent UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
DeleteCallGraphData
Deletes a call graph for the given package version that is captured in the parent UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateCIRun
Updates a specified CI run.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents the information captured from a CI run of endorctl. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListCIRuns
Lists all CI runs in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateCIRun
Creates a CI run.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (CI runs are associated with a tenant.) CI runs are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1CIRunSpec) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetCIRun
Fetches a CI run specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "run_uuid": "string",
- "run_tags": [
- "string"
], - "baseline": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteCIRun
Deletes a CI run specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListVersionDiffs
Lists all version diffs in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "pkg_version_uuid": "string",
- "to_pkg_version_uuid": "string",
- "func_diff": [
- {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
], - "type_diff": [
- {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateVersionDiff
Creates a version diff. The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Tenant metadata information.) Tenant metadata information. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1VersionDiffSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "pkg_version_uuid": "string",
- "to_pkg_version_uuid": "string",
- "func_diff": [
- {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
], - "type_diff": [
- {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "pkg_version_uuid": "string",
- "to_pkg_version_uuid": "string",
- "func_diff": [
- {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
], - "type_diff": [
- {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
]
}
}
GetVersionDiff
Fetches a version diff identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "pkg_version_uuid": "string",
- "to_pkg_version_uuid": "string",
- "func_diff": [
- {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
], - "type_diff": [
- {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}
]
}
}
DeleteVersionDiff
Deletes a version diff.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateClientLog
Creates a client log for a given object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the message that is accessed.) Namespace of the message that is accessed. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ClientLogSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "log_messages": [
- {
- "level": "LOG_LEVEL_UNSPECIFIED",
- "json_payload": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
], - "source": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "log_messages": [
- {
- "level": "LOG_LEVEL_UNSPECIFIED",
- "json_payload": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
], - "source": "string"
}
}
UpdateCodeOwners
Updates the CodeOwner object specified by the UUID.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Code owner information for a project. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
ListCodeOwners
Lists all CodeOwners objects in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateCodeOwners
Creates a CodeOwners object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Tenant data.) Tenant data. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1CodeOwnersSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
GetCodeOwners
Fetches the CodeOwners object identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "patterns": {
- "property1": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}
DeleteCodeOwners
Deletes the CodeOwners object specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateCertificate
Creates a new certificate from the provided certificate request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Tenant metadata required for certificate requests.) Tenant metadata required for certificate requests. |
object (v1CertificateRequestSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "certificate_request": "string",
- "type": "REQUEST_TYPE_UNSPECIFIED",
- "extensions": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "certificate_request": "string",
- "certificate": "string",
- "type": "REQUEST_TYPE_UNSPECIFIED",
- "extensions": {
- "runner_environment": "string",
- "source_repository": "string",
- "source_repository_digest": "string",
- "source_repository_owner": "string",
- "source_repository_ref": "string",
- "build_config_name": "string",
- "build_config_digest": "string",
- "certificate_identity": "string",
- "certificate_oidc_issuer": "string"
}
}
}
GetDefaultTemplate
Fetches the default template for the given template type.
path Parameters
custom_template_type required | string template_type is the type of the template. |
Responses
Response samples
- 200
- default
{- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
UpdateDashboardConfig
Updates a specified dashboard configuration.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object DashboardConfig represents the dashboard configuration for a namespace. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
ListDashboardConfig
Lists all dashboard configuration objects.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateDashboardConfig
Creates a dashboard configuration object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (DashboardConfig is associated with a tenant and namespace.) DashboardConfig is associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1DashboardConfigSpec) |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
GetDashboardConfig
Fetches a specified dashboard configuration.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "vuln_prioritization": {
- "epss_probability_score_threshold": 0.1,
- "finding_reachability_tags": [
- "FINDING_TAGS_UNSPECIFIED"
]
}, - "dev_estimate": {
- "baseline_findings_filter": "string",
- "dev_hours": 0.1,
- "hourly_cost": 0.1,
- "currency_code": "string"
}, - "sla_days": {
- "critical": 0,
- "high": 0,
- "medium": 0,
- "low": 0
}
}, - "propagate": true
}
DeleteDashboardConfig
Deletes a specified dashboard configuration.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateDemo
Updates a provided namespace based on its UUID.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Demo provides a mechanism for isolating groups of resources. Demos may be defined in a parent child hierarchy. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "requested_project": "string",
- "initiate_scan": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "workflow_url": "string",
- "demo_projects": [
- "string"
], - "requested_project": "string",
- "initiate_scan": true,
- "code_url": "string",
- "workflow_id": "string",
- "workflow_logs": "string",
- "job_status": { }
}
}
ListDemos
Lists all namespaces in a tenant.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "workflow_url": "string",
- "demo_projects": [
- "string"
], - "requested_project": "string",
- "initiate_scan": true,
- "code_url": "string",
- "workflow_id": "string",
- "workflow_logs": "string",
- "job_status": { }
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateDemo
Creates a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Demos are per tenant.) Demos are per tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1DemoSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "requested_project": "string",
- "initiate_scan": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "workflow_url": "string",
- "demo_projects": [
- "string"
], - "requested_project": "string",
- "initiate_scan": true,
- "code_url": "string",
- "workflow_id": "string",
- "workflow_logs": "string",
- "job_status": { }
}
}
GetDemo
Returns a provided namespace based on its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "workflow_url": "string",
- "demo_projects": [
- "string"
], - "requested_project": "string",
- "initiate_scan": true,
- "code_url": "string",
- "workflow_id": "string",
- "workflow_logs": "string",
- "job_status": { }
}
}
DeleteDemo
Deletes a provided namespace based on its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateDependencyMetadata
Update a specified dependency metadata object.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Information about the relationship between a root package version (importer) and one of its dependencies. DependencyMetadata objects are children of the root PackageVersion object and belong to the same project and namespace as the root PackageVersion object. They are connected to the importer project through spec.importer_data.project_uuid, and to the dependency project through spec.dependency_data.project_uuid. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListDependencyMetadata
List dependency metadata objects based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- null
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateDependencyMetadata
Creates a dependency metadata object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Information about the tenant to which the root package (importer) belongs.) Information about the tenant to which the root package (importer) belongs. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1DependencyMetadataSpec) DependencyMetadata specific data. |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetDependencyMetadata
Returns a specified dependency metadata object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteDependencyMetadata
Delete a specified dependency metadata object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateBatchDependencyMetadata
Create multiple dependency metadata objects through a batch API call.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1Meta) Common fields for all Endor Labs resources. | |
tenant_meta | object (Information about the tenant to which the root package (importer) belongs.) Information about the tenant to which the root package (importer) belongs. |
object (v1BatchDependencyMetadataSpec) BatchDependencyMetadata specific data. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "data": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- null
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "data": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "dependency_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "unresolved_version": "string",
- "resolved_version": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "direct": true,
- "pinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "namespace": "string",
- "parent_version_name": "string",
- "repo_name": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "internal": true,
- "parent_count": 0,
- "callgraph_available": true,
- "last_commit": "2019-08-24T14:15:22Z",
- "abstract": true,
- "orphan": true,
- "missing": true,
- "approximation": true,
- "public": true,
- "project_paths": [
- {
- "nodes": [
- "string"
]
}
], - "vendored": true,
- "discovery_type": "DISCOVERY_TYPE_UNSPECIFIED",
- "patched": true,
- "container_data": {
- "layers": [
- {
- "digest": "string",
- "file_locations": [
- null
], - "base_layer": true
}
]
}, - "purl": "string"
}, - "importer_data": {
- "project_uuid": "string",
- "package_name": "string",
- "package_version_uuid": "string",
- "package_version_name": "string",
- "package_version_sha": "string",
- "package_version_ref": "string",
- "callgraph_available": true,
- "version_name": "string",
- "container_base_image": {
- "name": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
]
}
}
UpdateEvaluationMethod
Updates the evaluation method.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object EvaluationMethod represents an evaluation method. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
ListEvaluationMethods
Lists all evaluation methods.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateEvaluationMethod
Creates an evaluation method.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (EvaluationMethods are associated with a tenant and namespace.) EvaluationMethods are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1EvaluationMethodSpec) |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
GetEvaluationMethod
Fetches the evaluation method identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "type": "EVALUATION_METHOD_TYPE_UNSPECIFIED",
- "system_method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_kinds": [
- "string"
]
}, - "propagate": true
}
DeleteEvaluationMethod
Deletes the evaluation method specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateEvaluationParameter
Updates an evaluation parameter.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object EvaluationParameter represents an evaluation parameter. The parameters are applied to the method before execution. The parameters correspond to the method identified by the parent UUID. Order of evaluation: For system methods, parameters at the system namespace are used first. If a tenant namespace has parameters for the same method, they overwrite the system level parameters. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
ListEvaluationParameters
Lists all evaluation parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateEvaluationParameter
Creates a evaluation parameter.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Evaluation parameters are associated with a tenant and namespace.) Evaluation parameters are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1EvaluationParameterSpec) |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
GetEvaluationParameter
Fetches the evaluation parameter identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "disable": true,
- "parameters": {
- "property1": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}, - "property2": {
- "string_value": "string",
- "int_value": "string",
- "bool_value": true,
- "float_value": 0.1
}
}
}, - "propagate": true
}
DeleteEvaluationParameter
Deletes the evaluation parameter specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListExternalProviderModels
Lists all external provider models in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "name": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED",
- "project_uuid": "string",
- "terms_of_service": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateExternalProviderModel
Creates an external provider model.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Models scanned per namespace.) Models scanned per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ExternalProviderModelSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "name": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED",
- "project_uuid": "string",
- "terms_of_service": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "name": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED",
- "project_uuid": "string",
- "terms_of_service": "string"
}
}
GetExternalProviderModel
Fetches the external provider model specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "name": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED",
- "project_uuid": "string",
- "terms_of_service": "string"
}
}
DeleteExternalProviderModel
Deletes a specified external provider model specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateFileSegments
Update a specified file segment object.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object File segment metadata for a given customer source file. Stored in mongo and used to refresh dependencies. NOTE: Not used for OSS-projects. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListFileSegments
List file segment objects based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateFileSegments
Creates a file segment object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the file segments.) Namespace of the file segments. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1FileSegmentsSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetFileSegments
Return a specified file segment object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteFileSegments
Delete a specified file segment object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateBatchFileSegments
Create multiple file segment objects through a batch API call.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1Meta) Common fields for all Endor Labs resources. | |
tenant_meta | object (Namespace of the file segments.) Namespace of the file segments. |
object (v1BatchFileSegmentsSpec) BatchFileSegments specific data. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "data": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "data": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "segments": [
- {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}
], - "file_hash": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
]
}
}
CreateFileHashQueryRequest
Creates a file hash query request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the filehash query request.) Namespace of the filehash query request. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1FileHashQueryRequestSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query": {
- "file_hashes": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "file_hashes": [
- "string"
], - "results": {
- "property1": {
- "file": "string",
- "library": "string",
- "version": "string",
- "version_unique": "string",
- "release_date": "2019-08-24T14:15:22Z"
}, - "property2": {
- "file": "string",
- "library": "string",
- "version": "string",
- "version_unique": "string",
- "release_date": "2019-08-24T14:15:22Z"
}
}
}
}
}
UpdateFinding
Update a specified finding.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object A finding contains details of a problem that needs to be fixed. The finding applies to the parent object, which can be one of: Repository, RepositoryVersion, or PackageVersion. Finding objects are connected to the project via spec.project_uuid. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- null
]
}, - "ranges": [
- {
- "type": null,
- "introduced": null,
- "fixed": null,
- "repo": null
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "database_specific": { },
- "severity": [
- {
- "type": null,
- "score": null
}
], - "credits": [
- {
- "name": null,
- "contact": [ ]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": null,
- "artifact_id": null,
- "vulnerable_versions": [ ],
- "fixed_versions": [ ],
- "vulnerable_filepath": [ ],
- "versions_range": [ ],
- "endor_uri": [ ]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- null
], - "references": [
- null
], - "metrics": {
- "cvss_metric_v2": [ ],
- "cvss_metric_v30": [ ],
- "cvss_metric_v31": [ ]
}, - "weaknesses": [
- null
], - "configurations": [
- null
], - "vendor_comments": [
- null
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- null
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": null,
- "algorithm": null
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": null,
- "algorithm": null
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": null,
- "algorithm": null
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": "string",
- "registry": "string",
- "product": "string",
- "version": "string",
- "namespace": "string",
- "language_specific": "string",
- "classname": "string",
- "function_or_attribute_name": "string",
- "args": [
- "string"
], - "return_type": "string",
- "declared_type": "string",
- "signature": "string"
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": null,
- "ecosystem": null,
- "purl": null
}, - "ranges": [
- null
], - "versions": [
- null
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- null
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- null
], - "fixed_versions": [
- null
], - "vulnerable_filepath": [
- null
], - "versions_range": [
- null
], - "endor_uri": [
- null
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": null,
- "value": null
}
], - "references": [
- {
- "url": null,
- "source": null,
- "tags": [ ]
}
], - "metrics": {
- "cvss_metric_v2": [
- null
], - "cvss_metric_v30": [
- null
], - "cvss_metric_v31": [
- null
]
}, - "weaknesses": [
- {
- "source": null,
- "type": null,
- "description": [ ]
}
], - "configurations": [
- {
- "operator": null,
- "negate": null,
- "nodes": [ ]
}
], - "vendor_comments": [
- {
- "organization": null,
- "comment": null,
- "last_modified": null
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": "string",
- "registry": "string",
- "product": "string",
- "version": "string",
- "namespace": "string",
- "language_specific": "string",
- "classname": "string",
- "function_or_attribute_name": "string",
- "args": [
- "string"
], - "return_type": "string",
- "declared_type": "string",
- "signature": "string"
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListFindings
List findings based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- null
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- null
], - "container_layers": [
- null
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": null,
- "property2": null
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": null,
- "property2": null
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": null,
- "release_time": null,
- "license": [ ],
- "checksums": [ ],
- "source_code_url": null,
- "platform_source": null,
- "source_code_ref": null,
- "last_updated": null,
- "license_info": [ ],
- "consumed": null
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": null,
- "release_time": null,
- "license": [ ],
- "checksums": [ ],
- "source_code_url": null,
- "platform_source": null,
- "source_code_ref": null,
- "last_updated": null,
- "license_info": [ ],
- "consumed": null
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": null,
- "release_time": null,
- "license": [ ],
- "checksums": [ ],
- "source_code_url": null,
- "platform_source": null,
- "source_code_ref": null,
- "last_updated": null,
- "license_info": [ ],
- "consumed": null
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": null,
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": null,
- "registry": null,
- "product": null,
- "version": null,
- "namespace": null,
- "language_specific": null,
- "classname": null,
- "function_or_attribute_name": null,
- "args": [ ],
- "return_type": null,
- "declared_type": null,
- "signature": null
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateFinding
Create a finding.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Information about the tenant and namespace that the finding belongs to.) Information about the tenant and namespace that the finding belongs to. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1FindingSpec) Finding specific data. |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": null,
- "ecosystem": null,
- "purl": null
}, - "ranges": [
- null
], - "versions": [
- null
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- null
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- null
], - "fixed_versions": [
- null
], - "vulnerable_filepath": [
- null
], - "versions_range": [
- null
], - "endor_uri": [
- null
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": null,
- "value": null
}
], - "references": [
- {
- "url": null,
- "source": null,
- "tags": [ ]
}
], - "metrics": {
- "cvss_metric_v2": [
- null
], - "cvss_metric_v30": [
- null
], - "cvss_metric_v31": [
- null
]
}, - "weaknesses": [
- {
- "source": null,
- "type": null,
- "description": [ ]
}
], - "configurations": [
- {
- "operator": null,
- "negate": null,
- "nodes": [ ]
}
], - "vendor_comments": [
- {
- "organization": null,
- "comment": null,
- "last_modified": null
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": "string",
- "registry": "string",
- "product": "string",
- "version": "string",
- "namespace": "string",
- "language_specific": "string",
- "classname": "string",
- "function_or_attribute_name": "string",
- "args": [
- "string"
], - "return_type": "string",
- "declared_type": "string",
- "signature": "string"
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": null,
- "ecosystem": null,
- "purl": null
}, - "ranges": [
- null
], - "versions": [
- null
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- null
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- null
], - "fixed_versions": [
- null
], - "vulnerable_filepath": [
- null
], - "versions_range": [
- null
], - "endor_uri": [
- null
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": null,
- "value": null
}
], - "references": [
- {
- "url": null,
- "source": null,
- "tags": [ ]
}
], - "metrics": {
- "cvss_metric_v2": [
- null
], - "cvss_metric_v30": [
- null
], - "cvss_metric_v31": [
- null
]
}, - "weaknesses": [
- {
- "source": null,
- "type": null,
- "description": [ ]
}
], - "configurations": [
- {
- "operator": null,
- "negate": null,
- "nodes": [ ]
}
], - "vendor_comments": [
- {
- "organization": null,
- "comment": null,
- "last_modified": null
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": "string",
- "registry": "string",
- "product": "string",
- "version": "string",
- "namespace": "string",
- "language_specific": "string",
- "classname": "string",
- "function_or_attribute_name": "string",
- "args": [
- "string"
], - "return_type": "string",
- "declared_type": "string",
- "signature": "string"
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetFinding
Fetch the finding identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "dependency_score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "root_package_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "dependency_score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "vulnerability": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": null,
- "ecosystem": null,
- "purl": null
}, - "ranges": [
- null
], - "versions": [
- null
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- null
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- null
], - "fixed_versions": [
- null
], - "vulnerable_filepath": [
- null
], - "versions_range": [
- null
], - "endor_uri": [
- null
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": null,
- "value": null
}
], - "references": [
- {
- "url": null,
- "source": null,
- "tags": [ ]
}
], - "metrics": {
- "cvss_metric_v2": [
- null
], - "cvss_metric_v30": [
- null
], - "cvss_metric_v31": [
- null
]
}, - "weaknesses": [
- {
- "source": null,
- "type": null,
- "description": [ ]
}
], - "configurations": [
- {
- "operator": null,
- "negate": null,
- "nodes": [ ]
}
], - "vendor_comments": [
- {
- "organization": null,
- "comment": null,
- "last_modified": null
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}, - "root_package_resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "source_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "ci_blocking_policy_info": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "finding_name": "string",
- "results": [
- {
- "fields": {
- "property1": "string",
- "property2": "string"
}
}
], - "tags": [
- "string"
]
}, - "root_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "dependency_package_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "typosquatted_dependency_version_metadata": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}, - "container_data": {
- "layer_digests": [
- "string"
], - "has_base_layer": true,
- "base_image": "string"
}, - "custom": null,
- "security_review_data": {
- "ai_meta": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "confidence_justification": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED"
}, - "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "justification": "string",
- "code_snippet": {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
}
}, - "summary": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "reachable_paths": [
- {
- "nodes": [
- {
- "function_ref": {
- "language": "string",
- "registry": "string",
- "product": "string",
- "version": "string",
- "namespace": "string",
- "language_specific": "string",
- "classname": "string",
- "function_or_attribute_name": "string",
- "args": [
- "string"
], - "return_type": "string",
- "declared_type": "string",
- "signature": "string"
}, - "package_version": "string",
- "internal": true
}
]
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- "string"
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [
- "string"
], - "tags": [
- "string"
]
}, - "actions": {
- "policy_uuids": [
- "string"
]
}, - "fixing_upgrades": {
- "upgrade_list": [
- {
- "package_name": "string",
- "direct_dependency_name": "string",
- "from_version": "string",
- "to_version": "string",
- "upgrade_risk": "string"
}
]
}, - "fixing_patch": {
- "endor_patch_available": true
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteFinding
Delete the finding specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListFindingLogs
Returns a list of finding logs based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "finding_uuid": "string",
- "finding_parent_kind": "string",
- "finding_parent_uuid": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "introduced_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "days_unresolved": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "target_uuid": "string",
- "target_dependency_package_name": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateFindingLog
Creates a finding log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the finding log.) Namespace of the finding log. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1FindingLogSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "finding_uuid": "string",
- "finding_parent_kind": "string",
- "finding_parent_uuid": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "introduced_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "days_unresolved": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "target_uuid": "string",
- "target_dependency_package_name": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "finding_uuid": "string",
- "finding_parent_kind": "string",
- "finding_parent_uuid": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "introduced_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "days_unresolved": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "target_uuid": "string",
- "target_dependency_package_name": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetFindingLog
Returns a specified finding log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "finding_uuid": "string",
- "finding_parent_kind": "string",
- "finding_parent_uuid": "string",
- "operation": "OPERATION_UNSPECIFIED",
- "introduced_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "days_unresolved": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "target_uuid": "string",
- "target_dependency_package_name": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteFindingLog
Deletes a finding log specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateFunctionGraphData
Updates the metadata of a callgraph.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object FunctionGraphData represents a function graph data request in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
ListFunctionGraphData
Lists all function graph data in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateFunctionGraphData
Creates a function graph. The object must provide a parent ID that is the associated package version to which the function graph belongs. A create operation will replace any previous data and is considered an upsert.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Namespaces are associated with a tenant.) Namespaces are associated with a tenant. |
zstd_bytes | string <byte> Function graph proto bytes are encoded in zstd bytes. It is the responsibility of the caller to compress/uncompress the bytes. |
object (googleprotobufAny)
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++.
Example 2: Pack and unpack a message in Java.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON The JSON representation of an
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
| |
object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
GetFunctionGraphData
Fetches the function graph for a given package version that is captured in the parent_uuid.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "zstd_bytes": "string",
- "any": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "related_object": "string",
- "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "storage_url": "string"
}
DeleteFunctionGraphData
Deletes a function graph for the given package version that is captured in the parent_uuid.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListGithubTokens
Lists all available GitHub tokens.
query Parameters
filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
action | string Action to be executed with a request. Not supported for all endpoints. |
mask | string List of fields to return (all fields are returned by default). |
traverse | boolean Get data from any child namespaces as well. |
sort.path | string Field to sort objects by, for example, meta.name. |
sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
ci_run_uuid | string Only return objects from PR scans that match this context id. |
page_id | string Page ID to retrieve. |
group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "spec": {
- "token": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
ListHuggingFaceModels
Lists all HuggingFace models in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "id": "string",
- "name": "string",
- "model_id": "string",
- "author": "string",
- "sha": "string",
- "last_modified": "2019-08-24T14:15:22Z",
- "private": true,
- "disabled": true,
- "gated": {
- "mode_type": "string",
- "disabled": true
}, - "pipeline_tag": "string",
- "tags": [
- "string"
], - "downloads": 0,
- "library_name": "string",
- "mask_token": "string",
- "widget_data": [
- { }
], - "likes": 0,
- "model_index": [
- { }
], - "config": { },
- "card_data": { },
- "transformers_info": { },
- "spaces": [
- "string"
], - "siblings": [
- {
- "rfilename": "string"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "safetensors": { },
- "readme_content": "string",
- "config_content": "string",
- "authorization_required": true,
- "discussions": {
- "count": 0,
- "num_closed": 0
}, - "pull_requests": {
- "count": 0,
- "num_closed": 0
}, - "project_uuid": "string",
- "readme_metadata": {
- "example_code": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "base_model": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "training_data": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "fine_tuned": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "alignment_trained": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "linked_github": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "evaluation_results": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateHuggingFaceModel
Creates a HuggingFace model.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Models scanned per namespace.) Models scanned per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1HuggingFaceModelSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "id": "string",
- "name": "string",
- "model_id": "string",
- "author": "string",
- "sha": "string",
- "last_modified": "2019-08-24T14:15:22Z",
- "private": true,
- "disabled": true,
- "gated": {
- "mode_type": "string",
- "disabled": true
}, - "pipeline_tag": "string",
- "tags": [
- "string"
], - "downloads": 0,
- "library_name": "string",
- "mask_token": "string",
- "widget_data": [
- { }
], - "likes": 0,
- "model_index": [
- { }
], - "config": { },
- "card_data": { },
- "transformers_info": { },
- "spaces": [
- "string"
], - "siblings": [
- {
- "rfilename": "string"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "safetensors": { },
- "readme_content": "string",
- "config_content": "string",
- "authorization_required": true,
- "discussions": {
- "count": 0,
- "num_closed": 0
}, - "pull_requests": {
- "count": 0,
- "num_closed": 0
}, - "project_uuid": "string",
- "readme_metadata": {
- "example_code": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "base_model": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "training_data": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "fine_tuned": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "alignment_trained": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "linked_github": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "evaluation_results": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "id": "string",
- "name": "string",
- "model_id": "string",
- "author": "string",
- "sha": "string",
- "last_modified": "2019-08-24T14:15:22Z",
- "private": true,
- "disabled": true,
- "gated": {
- "mode_type": "string",
- "disabled": true
}, - "pipeline_tag": "string",
- "tags": [
- "string"
], - "downloads": 0,
- "library_name": "string",
- "mask_token": "string",
- "widget_data": [
- { }
], - "likes": 0,
- "model_index": [
- { }
], - "config": { },
- "card_data": { },
- "transformers_info": { },
- "spaces": [
- "string"
], - "siblings": [
- {
- "rfilename": "string"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "safetensors": { },
- "readme_content": "string",
- "config_content": "string",
- "authorization_required": true,
- "discussions": {
- "count": 0,
- "num_closed": 0
}, - "pull_requests": {
- "count": 0,
- "num_closed": 0
}, - "project_uuid": "string",
- "readme_metadata": {
- "example_code": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "base_model": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "training_data": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "fine_tuned": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "alignment_trained": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "linked_github": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "evaluation_results": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}
}
}
}
GetHuggingFaceModel
Fetches the HuggingFace model specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "id": "string",
- "name": "string",
- "model_id": "string",
- "author": "string",
- "sha": "string",
- "last_modified": "2019-08-24T14:15:22Z",
- "private": true,
- "disabled": true,
- "gated": {
- "mode_type": "string",
- "disabled": true
}, - "pipeline_tag": "string",
- "tags": [
- "string"
], - "downloads": 0,
- "library_name": "string",
- "mask_token": "string",
- "widget_data": [
- { }
], - "likes": 0,
- "model_index": [
- { }
], - "config": { },
- "card_data": { },
- "transformers_info": { },
- "spaces": [
- "string"
], - "siblings": [
- {
- "rfilename": "string"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "safetensors": { },
- "readme_content": "string",
- "config_content": "string",
- "authorization_required": true,
- "discussions": {
- "count": 0,
- "num_closed": 0
}, - "pull_requests": {
- "count": 0,
- "num_closed": 0
}, - "project_uuid": "string",
- "readme_metadata": {
- "example_code": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "base_model": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "training_data": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "fine_tuned": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "alignment_trained": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "linked_github": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}, - "evaluation_results": {
- "prompt": "string",
- "raw_response": "string",
- "exists": true,
- "answer": [
- "string"
], - "evidence": "string"
}
}
}
}
DeleteHuggingFaceModel
Deletes a specified HuggingFace model specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateIdentityProvider
Updates an identity provider.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents an identity provider. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
ListIdentityProviders
Lists all identity providers.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateIdentityProvider
Creates an identity provider.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (IdentityProviders are associated with a tenant and namespace.) IdentityProviders are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1IdentityProviderSpec) |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
GetIdentityProvider
Fetches the identity provider specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "oidc_provider": {
- "discover_url": "string",
- "key": "string",
- "secret": "string",
- "scopes": [
- "string"
], - "claim_names": [
- "string"
]
}, - "saml_provider": {
- "provider_metadata_url": "string",
- "sso_url": "string",
- "issuer": "string",
- "certificates": [
- "string"
], - "attribute_names": [
- "string"
]
}
}, - "propagate": true
}
DeleteIdentityProvider
Deletes the identity provider specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateSegmentIndexRequest
Creates a segment index request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the segment index request.) Namespace of the segment index request. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1SegmentIndexRequestSpec) |
object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "segments": [
- {
- "source_uri": "string",
- "package_version": "string",
- "sha": "string",
- "path": "string",
- "function_ref": "string",
- "line_start": 0,
- "line_end": 0,
- "content": "string",
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "commit_time": "2019-08-24T14:15:22Z",
- "metadata": {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}, - "language": "LANGUAGE_UNSPECIFIED",
- "file_hash": "string",
- "blame_time": "2019-08-24T14:15:22Z",
- "cyclomatic_complexity": 0,
- "rest": true
}
], - "project_uuid": "string",
- "ref": "string",
- "sha": "string",
- "segmentation_done": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "segments": [
- {
- "source_uri": "string",
- "package_version": "string",
- "sha": "string",
- "path": "string",
- "function_ref": "string",
- "line_start": 0,
- "line_end": 0,
- "content": "string",
- "annotations": {
- "property1": "string",
- "property2": "string"
}, - "commit_time": "2019-08-24T14:15:22Z",
- "metadata": {
- "signature": "string",
- "embedding": {
- "vector": [
- 0.1
]
}, - "code_size": "string"
}, - "language": "LANGUAGE_UNSPECIFIED",
- "file_hash": "string",
- "blame_time": "2019-08-24T14:15:22Z",
- "cyclomatic_complexity": 0,
- "rest": true
}
], - "project_uuid": "string",
- "ref": "string",
- "sha": "string",
- "segmentation_done": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
UpdateInstallation
Updates an installation.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Installation represents an installation request in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "public": true,
- "external_id": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "public": true,
- "external_id": "string",
- "external_name": "string",
- "user": "string",
- "ingestion_time": "2019-08-24T14:15:22Z",
- "target_type": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "login": "string",
- "invalid": true,
- "ingestion_token": "string",
- "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "app_id": "string",
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true,
- "installation_github_user": "string"
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "marked_for_deletion": true,
- "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
ListInstallations
Lists all installations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "public": true,
- "external_id": "string",
- "external_name": "string",
- "user": "string",
- "ingestion_time": "2019-08-24T14:15:22Z",
- "target_type": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "login": "string",
- "invalid": true,
- "ingestion_token": "string",
- "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "app_id": "string",
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true,
- "installation_github_user": "string"
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "marked_for_deletion": true,
- "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateInstallation
creates a installation. The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource were already created.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Namespaces are associated with a tenant.) Namespaces are associated with a tenant. |
object (v1InstallationSpec) | |
object (v1ProcessingStatus) | |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "public": true,
- "external_id": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "public": true,
- "external_id": "string",
- "external_name": "string",
- "user": "string",
- "ingestion_time": "2019-08-24T14:15:22Z",
- "target_type": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "login": "string",
- "invalid": true,
- "ingestion_token": "string",
- "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "app_id": "string",
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true,
- "installation_github_user": "string"
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "marked_for_deletion": true,
- "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
GetInstallation
Fetches an installation identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "public": true,
- "external_id": "string",
- "external_name": "string",
- "user": "string",
- "ingestion_time": "2019-08-24T14:15:22Z",
- "target_type": "string",
- "suspended": true,
- "project_uuids": [
- "string"
], - "login": "string",
- "invalid": true,
- "ingestion_token": "string",
- "enabled_features": [
- "ENABLED_FEATURE_TYPE_UNSPECIFIED"
], - "platform_source": "PLATFORM_SOURCE_TYPE_UNSPECIFIED",
- "platform_type": "PLATFORM_SOURCE_UNSPECIFIED",
- "github_config": {
- "app_id": "string",
- "enable_pr_scans": true,
- "enable_pr_comments": true,
- "enable_full_scan": true,
- "include_archived_repos": true,
- "installation_github_user": "string"
}, - "azure_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "gitlab_config": {
- "host_url": "string",
- "personal_access_token": "string"
}, - "bitbucket_config": {
- "host_url": "string",
- "cloud": {
- "app_password_config": {
- "username": "string",
- "app_password": "string"
}, - "access_token": "string"
}, - "data_center": {
- "http_access_token": "string"
}
}, - "marked_for_deletion": true,
- "include_archived_repos": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
DeleteInstallation
Deletes an installation specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateInvitation
Updates the invitation.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Invitation represents an invitation for a new user in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
ListInvitations
Lists the invitations in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateInvitation
Creates an invitation.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Invitations can be issued per namespace.) Invitations can be issued per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1InvitationSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
GetInvitation
Fetches the invitation identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_email": "string",
- "invitation_state": "INVITATION_STATE_UNSPECIFIED"
}
}
DeleteInvitation
Deletes the invitation specified by the UUID
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateIPAddressPolicy
Updates a specified IPAddressPolicy.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object An IPAddressPolicy creates a restriction on which IP address subnets can access a tenant. Note that only one IP address policy is allowed per tenant and IP address policies cannot be declared in child namespaces. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
ListIPAddresssPolicies
Returns a list of finding logs based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateIPAddressPolicy
Creates a finding log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the ip address policy.) Namespace of the ip address policy. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1IPAddressPolicySpec) |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. It should be set to true for most use cases. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
GetIPAddressPolicy
Returns a specified finding log.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "allowed_ip_subnets": [
- "string"
]
}, - "propagate": true
}
DeleteIPAddressPolicy
Deletes a finding log specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateJVMClassMetadata
Updates an jvm class metadata.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object JVMClassMetadata contains metadata such as file sha, name, gav of oss library for a jvm class file. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
ListJVMClassMetadata
Lists all jvm class metadata in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateJVMClassMetadata
Creates a jvm class metadata.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (JVMClassMetadata are associated with a tenant.) JVMClassMetadata are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1JVMClassMetadataSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
GetJVMClassMetadata
Fetches the class metadata for a jvm class given an uuid.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "file_name": "string",
- "gav": "string",
- "is_original_sha": true,
- "last_modified_time": "2019-08-24T14:15:22Z",
- "is_rebundled": true
}
}
DeleteJVMClassMetadata
Deletes a jvm class metadata of a specified UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateLicense
Updates the license.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents a license in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
ListLicenses
Lists all licenses in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateLicense
Creates a license.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Licenses live in the system namespace.) Licenses live in the system namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1LicenseSpec) Specification mostly follows the SPDX data format. |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
GetLicense
Fetches the license specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "license_id": "string",
- "license_name": "string",
- "license_text": "string",
- "is_deprecated": true,
- "is_osi_approved": true,
- "additional_info": [
- "string"
], - "category": "string",
- "short_name": "string"
}, - "propagate": true
}
DeleteLicense
Deletes the license identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateLinterResult
Updates a linter result.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The meta parent_kind can take one of two values - PackageVersion or RepositoryVersion. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": "string",
- "uri_base_id": "string"
}, - "region": {
- "start_column": 0,
- "end_column": 0,
- "start_line": 0,
- "end_line": 0,
- "snippet": {
- "text": "string"
}
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": "string",
- "uri_base_id": "string"
}, - "region": {
- "start_column": 0,
- "end_column": 0,
- "start_line": 0,
- "end_line": 0,
- "snippet": {
- "text": "string"
}
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListLinterResults
Lists all linter results.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": null,
- "uri_base_id": null
}, - "region": {
- "start_column": null,
- "end_column": null,
- "start_line": null,
- "end_line": null,
- "snippet": null
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateLinterResult
Creates a Semgrep rule.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Linter results are associated with a tenant and namespace.) Linter results are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1LinterResultSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": "string",
- "uri_base_id": "string"
}, - "region": {
- "start_column": 0,
- "end_column": 0,
- "start_line": 0,
- "end_line": 0,
- "snippet": {
- "text": "string"
}
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": "string",
- "uri_base_id": "string"
}, - "region": {
- "start_column": 0,
- "end_column": 0,
- "start_line": 0,
- "end_line": 0,
- "snippet": {
- "text": "string"
}
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetLinterResult
Fetches the linter result identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "origin": "LINTER_RESULT_ORIGIN_UNSPECIFIED",
- "version": "string",
- "sarif_result": {
- "rule_id": "string",
- "message": {
- "text": "string"
}, - "locations": [
- {
- "physical_location": {
- "artifact_location": {
- "uri": "string",
- "uri_base_id": "string"
}, - "region": {
- "start_column": 0,
- "end_column": 0,
- "start_line": 0,
- "end_line": 0,
- "snippet": {
- "text": "string"
}
}
}
}
], - "fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "partial_fingerprints": {
- "id": "string",
- "hash": "string",
- "commit_sha": "string",
- "email": "string",
- "author": "string",
- "date": "string",
- "commit_message": "string"
}, - "properties": {
- "tags": [
- "string"
], - "cvss_score": 0.1,
- "epss_probability_score": 0.1,
- "epss_percentile_score": 0.1,
- "finding_uuid": "string",
- "project_uuid": "string",
- "finding_url": "string",
- "action_policies_triggered": [
- "string"
], - "cvss_vector": "string",
- "categories": [
- "string"
], - "impact_score": 0.1,
- "explanation": "string",
- "remediation": "string"
}, - "suppressions": [
- {
- "kind": "KIND_UNSPECIFIED"
}
], - "level": "string"
}, - "level": "LINTER_RESULT_LEVEL_UNSPECIFIED",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "extra_key": "string",
- "semgrep": {
- "severity": "string",
- "likelihood": "string",
- "confidence": "string",
- "tags": [
- "string"
], - "description": "string",
- "explanation": "string",
- "remediation": "string",
- "impact": "string",
- "languages": [
- "string"
], - "rule_name": "string",
- "rule_uuid": "string",
- "cwes": [
- "string"
], - "rule_version": "string"
}, - "secret": {
- "validation": "VALIDATION_STATUS_UNSPECIFIED",
- "git_log_scanned": true,
- "secret_id": "string",
- "fs_scanned": true
}, - "fingerprints": [
- "string"
], - "fingerprint_count": 0,
- "distribution_format": "DISTRIBUTION_FORMAT_TYPE_UNSPECIFIED",
- "ref": "string",
- "storage_location": "string",
- "suppressed": true
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteLinterResult
Deletes the linter result specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateMetric
Updates a specified metric. This will only be used by the backend services, the user/UI wil never have to do this.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object This contains the definition all metrics. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- null
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- null
], - "related": [
- null
], - "cvss_v3_severity": {
- "score": null,
- "vector": null,
- "level": null,
- "temporal_score": null,
- "temporal_vector": null,
- "temporal_level": null
}, - "credits": [
- null
], - "database_specific": { },
- "summary": "string",
- "affected": [
- null
], - "references": [
- null
], - "epss_score": {
- "probability_score": null,
- "percentile_score": null
}, - "raw": {
- "osv_vulnerability": null,
- "endor_vulnerability": null,
- "epss_record": null,
- "nvd_vulnerability": null,
- "kev_record": null
}, - "malicious": true,
- "additional_endor_notes": [
- null
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- null
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- null
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": null,
- "file_regex": null,
- "line_number": null,
- "line_content": null,
- "line_regex": null,
- "url": null,
- "url_regex": null,
- "badge": null,
- "badge_regex": null,
- "parent_tool_name": null,
- "app_slug": null,
- "app_id": null,
- "app_repo_url": null,
- "app_permissions": { },
- "app_settings_url": null
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": null,
- "name": null,
- "permissions": [ ],
- "actions": [ ],
- "unpinned_runner_version": null,
- "script_injection_detected": [ ],
- "unpinned_commit_sha_actions": [ ],
- "unverified_gh_actions": [ ],
- "cloud_resource_accessed_without_oidc": [ ],
- "untrusted_code_execution": [ ]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": null,
- "evidence": null,
- "location_uri": null
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": null,
- "description": null,
- "change_kind": null,
- "security_label": null
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": null,
- "description": null,
- "line": null,
- "line_end": null
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": null,
- "description": null,
- "change_kind": null,
- "security_label": null
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": null,
- "description": null,
- "line": null,
- "line_end": null
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": null,
- "line": null,
- "line_end": null,
- "snippet": null,
- "description": null,
- "impact": null,
- "change_kind": null,
- "language": null
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- null
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- null
], - "related": [
- null
], - "cvss_v3_severity": {
- "score": null,
- "vector": null,
- "level": null,
- "temporal_score": null,
- "temporal_vector": null,
- "temporal_level": null
}, - "credits": [
- null
], - "database_specific": { },
- "summary": "string",
- "affected": [
- null
], - "references": [
- null
], - "epss_score": {
- "probability_score": null,
- "percentile_score": null
}, - "raw": {
- "osv_vulnerability": null,
- "endor_vulnerability": null,
- "epss_record": null,
- "nvd_vulnerability": null,
- "kev_record": null
}, - "malicious": true,
- "additional_endor_notes": [
- null
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- null
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- null
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": null,
- "file_regex": null,
- "line_number": null,
- "line_content": null,
- "line_regex": null,
- "url": null,
- "url_regex": null,
- "badge": null,
- "badge_regex": null,
- "parent_tool_name": null,
- "app_slug": null,
- "app_id": null,
- "app_repo_url": null,
- "app_permissions": { },
- "app_settings_url": null
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": null,
- "name": null,
- "permissions": [ ],
- "actions": [ ],
- "unpinned_runner_version": null,
- "script_injection_detected": [ ],
- "unpinned_commit_sha_actions": [ ],
- "unverified_gh_actions": [ ],
- "cloud_resource_accessed_without_oidc": [ ],
- "untrusted_code_execution": [ ]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": null,
- "evidence": null,
- "location_uri": null
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": null,
- "description": null,
- "change_kind": null,
- "security_label": null
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": null,
- "description": null,
- "line": null,
- "line_end": null
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": null,
- "description": null,
- "change_kind": null,
- "security_label": null
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": null,
- "description": null,
- "line": null,
- "line_end": null
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": null,
- "line": null,
- "line_end": null,
- "snippet": null,
- "description": null,
- "impact": null,
- "change_kind": null,
- "language": null
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListMetrics
Lists all metrics in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": null,
- "score": null,
- "description": null,
- "centered_score": null,
- "raw_score": null
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": null,
- "score": null,
- "description": null,
- "name": null,
- "evidence": null,
- "id": null,
- "score_float": null
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
], - "monthly_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
], - "yearly_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}, - "property2": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}
}, - "languages": {
- "property1": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}, - "property2": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": null,
- "unpinned": null,
- "reachable": null,
- "utilization": null,
- "dependency_version": null
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": null,
- "category": null,
- "sub_category": null,
- "index": null,
- "criteria": null,
- "description": null,
- "rationale": null,
- "audit": null,
- "remediation": null,
- "satisfied": null,
- "version": null
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- null
], - "webhooks": [
- null
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- null
], - "action_policies": {
- "allowed_actions": null,
- "enabled_repositories": null
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": null,
- "status": null
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- null
], - "default_branch_protection_status": true,
- "webhooks": [
- null
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "likelihood": null,
- "category": null,
- "critical_api_category": null,
- "tags": [ ],
- "snippet": null
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "likelihood": null,
- "category": null,
- "critical_api_category": null,
- "tags": [ ],
- "snippet": null
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "package_manager_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "snippet": null
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": null,
- "categories": [ ],
- "summary": [ ],
- "evidence": [ ],
- "description": null,
- "display_name": null
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": null,
- "file_path": null,
- "jobs": [ ],
- "permissions": [ ],
- "all_secrets_exposed": [ ]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": null,
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": null,
- "change_kind": null,
- "changed_functions": [ ],
- "purpose": null,
- "code_change_description": [ ],
- "added_lines": null,
- "removed_lines": null
}, - "property2": {
- "path": null,
- "change_kind": null,
- "changed_functions": [ ],
- "purpose": null,
- "code_change_description": [ ],
- "added_lines": null,
- "removed_lines": null
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": null,
- "title": null,
- "description": null,
- "snippets": [ ],
- "severity_level": null,
- "justification": null,
- "confidence_level": null,
- "confidence_justification": null
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": null,
- "score": null,
- "description": null,
- "centered_score": null,
- "raw_score": null
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": null,
- "score": null,
- "description": null,
- "name": null,
- "evidence": null,
- "id": null,
- "score_float": null
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
], - "monthly_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
], - "yearly_activity": [
- {
- "timestamp": null,
- "count": null,
- "tag_activity": { }
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}, - "property2": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}
}, - "languages": {
- "property1": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}, - "property2": {
- "file_count": null,
- "line_count": null,
- "byte_count": null
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": null,
- "unpinned": null,
- "reachable": null,
- "utilization": null,
- "dependency_version": null
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": null,
- "category": null,
- "sub_category": null,
- "index": null,
- "criteria": null,
- "description": null,
- "rationale": null,
- "audit": null,
- "remediation": null,
- "satisfied": null,
- "version": null
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- null
], - "webhooks": [
- null
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- null
], - "action_policies": {
- "allowed_actions": null,
- "enabled_repositories": null
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": null,
- "status": null
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- null
], - "default_branch_protection_status": true,
- "webhooks": [
- null
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "likelihood": null,
- "category": null,
- "critical_api_category": null,
- "tags": [ ],
- "snippet": null
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "likelihood": null,
- "category": null,
- "critical_api_category": null,
- "tags": [ ],
- "snippet": null
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "package_manager_licenses": [
- {
- "name": null,
- "spdxid": null,
- "mapping_info": null,
- "type": null,
- "url": null,
- "file": null,
- "file_location": null,
- "matched_text": null
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": null,
- "file": null,
- "line": null,
- "match": null,
- "severity": null,
- "confidence": null,
- "snippet": null
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": null,
- "categories": [ ],
- "summary": [ ],
- "evidence": [ ],
- "description": null,
- "display_name": null
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": null,
- "file_path": null,
- "jobs": [ ],
- "permissions": [ ],
- "all_secrets_exposed": [ ]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": null,
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": null,
- "change_kind": null,
- "changed_functions": [ ],
- "purpose": null,
- "code_change_description": [ ],
- "added_lines": null,
- "removed_lines": null
}, - "property2": {
- "path": null,
- "change_kind": null,
- "changed_functions": [ ],
- "purpose": null,
- "code_change_description": [ ],
- "added_lines": null,
- "removed_lines": null
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": null,
- "title": null,
- "description": null,
- "snippets": [ ],
- "severity_level": null,
- "justification": null,
- "confidence_level": null,
- "confidence_justification": null
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateMetric
Creates a metric for the given parent. This will be only called by the backend services, and not from the user/UI It should be noted that the creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource were already created.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Metrics are associated with a tenant and tenant information must be provided.) Metrics are associated with a tenant and tenant information must be provided. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1MetricSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetMetric
Fetches a metric specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "analytic": "string",
- "project_uuid": "string",
- "metric_values": {
- "property1": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}, - "property2": {
- "category": "string",
- "description": "string",
- "int32_value": 0,
- "int64_value": "string",
- "string_value": "string",
- "float_value": 0.1,
- "score_card": {
- "overall_score": 0.1,
- "category_scores": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "centered_score": 0.1,
- "raw_score": 0.1
}
], - "analysis_scope_description": "string"
}, - "score_factor_list": {
- "score_factors": [
- {
- "category": "SCORE_CATEGORY_UNSPECIFIED",
- "score": 0,
- "description": "string",
- "name": "string",
- "evidence": "string",
- "id": "string",
- "score_float": 0.1
}
]
}, - "time_tracker": {
- "resolutions": [
- "TIME_RESOLUTION_UNSPECIFIED"
], - "daily_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "monthly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
], - "yearly_activity": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "count": "string",
- "tag_activity": {
- "property1": "string",
- "property2": "string"
}
}
]
}, - "file_stats": {
- "file_info": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "has_codeowners": true,
- "has_license": true,
- "has_security_md": true,
- "license_name": "string",
- "license_type": "string",
- "documentation_files": [
- "string"
], - "test_files": [
- "string"
], - "cicd_files": [
- "string"
], - "best_practices_files": [
- "string"
], - "sast_files": [
- "string"
], - "make_files": [
- "string"
], - "badges": [
- "string"
], - "file_types": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "languages": {
- "property1": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}, - "property2": {
- "file_count": "string",
- "line_count": "string",
- "byte_count": "string"
}
}, - "copyrights": [
- "string"
]
}, - "vulnerability_stats": {
- "critical_vulnerabilities": 0,
- "high_vulnerabilities": 0,
- "medium_vulnerabilities": 0,
- "low_vulnerabilities": 0,
- "vulnerabilities": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
]
}, - "dependency_stats": {
- "dependency_specs": [
- {
- "dependency_name": "string",
- "unpinned": true,
- "reachable": "REACHABILITY_TYPE_UNSPECIFIED",
- "utilization": 0.1,
- "dependency_version": "string"
}
], - "unpinned_dependencies": 0,
- "unused_dependencies": 0,
- "unpinned_direct_dependencies": 0,
- "unused_direct_dependencies": 0,
- "direct_dependencies": 0,
- "indirect_dependencies": 0
}, - "tag_counts": {
- "counts": {
- "property1": "string",
- "property2": "string"
}
}, - "cis_scorecard": {
- "benchmarks": [
- {
- "id": "CIS_REQ_ID_UNSPECIFIED",
- "category": "CIS_CATEGORY_UNSPECIFIED",
- "sub_category": "CIS_SUB_CATEGORY_UNSPECIFIED",
- "index": "string",
- "criteria": "string",
- "description": "string",
- "rationale": "string",
- "audit": "string",
- "remediation": "string",
- "satisfied": true,
- "version": "string"
}
]
}, - "scpm_data": {
- "organization_access": {
- "verified": true,
- "mfa_external": true,
- "mfa_internal": true,
- "allow_public_repo_create": true,
- "allow_private_repo_create": true,
- "allow_internal_repo_create": true,
- "allow_private_repo_fork": true,
- "repo_get_permission": "string",
- "repo_edit_permission": "string",
- "admins": [
- "string"
], - "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "workflows_can_approve_prs": true,
- "default_workflow_permissions": "string",
- "runner_group": [
- {
- "id": "string",
- "name": "string",
- "visibility": "string",
- "allows_public_repos": true,
- "url": "string"
}
], - "action_policies": {
- "allowed_actions": "string",
- "enabled_repositories": "string"
}
}, - "repository_access": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "archived": true,
- "disabled": true,
- "private": true,
- "allow_fork": true,
- "allow_squash_merge": true,
- "allow_merge_commit": true,
- "allow_rebase_merge": true,
- "allow_auto_merge": true,
- "require_web_commit_signoff": true,
- "advanced_security_enabled": true,
- "admins": [
- "string"
], - "default_branch_protection_status": true,
- "webhooks": [
- {
- "type": "string",
- "name": "string",
- "url": "string",
- "config_url": "string",
- "deliveries_url": "string",
- "ping_url": "string",
- "test_url": "string",
- "insecure_ssl": true,
- "active": true,
- "events": [
- "string"
], - "id": "string",
- "secret": "string"
}
], - "pushed_at": "2019-08-24T14:15:22Z"
}, - "branch_access": {
- "allow_create": true,
- "allow_delete": true,
- "allow_force_push": true,
- "allow_fork_sync": true,
- "allow_review_bypass": true,
- "allow_self_approval": true,
- "dismiss_stale_approvals": true,
- "enforce_admins": true,
- "is_locked": true,
- "linear_history": true,
- "require_code_owner_approval": true,
- "require_comment_resolution": true,
- "require_signatures": true,
- "require_status_checks": true,
- "require_update": true,
- "restrict_dismiss": true,
- "restrict_push": true,
- "num_approvals_required": 0
}, - "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "raw": { }
}, - "linter_stats": {
- "result_count": 0,
- "files_with_result_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_results": 0,
- "results_per_filecnt_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_severity": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_filecnt_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_per_loc_ratio_by_file_type": {
- "property1": 0.1,
- "property2": 0.1
}, - "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
], - "results_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_critical_api_category": {
- "property1": 0,
- "property2": 0
}, - "finding_results": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "likelihood": "string",
- "category": "string",
- "critical_api_category": "string",
- "tags": [
- "string"
], - "snippet": "string"
}
]
}, - "license_info": {
- "all_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "repository_license": {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}, - "code_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "package_manager_licenses": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "copyrights": [
- "string"
]
}, - "secret_stats": {
- "result_count": 0,
- "files_with_secrets_count": 0,
- "distinct_rules_with_results": 0,
- "distinct_file_types_with_secrets": 0,
- "results_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "results_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_severity": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_rule": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_file_type": {
- "property1": 0,
- "property2": 0
}, - "file_cnt_by_category": {
- "property1": 0,
- "property2": 0
}, - "secrets": [
- {
- "rule_id": "string",
- "file": "string",
- "line": 0,
- "match": "string",
- "severity": "string",
- "confidence": "string",
- "snippet": "string"
}
]
}, - "ci_cd_tools": {
- "tools": [
- {
- "name": "string",
- "categories": [
- "string"
], - "summary": [
- "string"
], - "evidence": [
- {
- "file_path": "string",
- "file_regex": "string",
- "line_number": 0,
- "line_content": "string",
- "line_regex": "string",
- "url": "string",
- "url_regex": "string",
- "badge": "string",
- "badge_regex": "string",
- "parent_tool_name": "string",
- "app_slug": "string",
- "app_id": "string",
- "app_repo_url": "string",
- "app_permissions": {
- "property1": null,
- "property2": null
}, - "app_settings_url": "string"
}
], - "description": "string",
- "display_name": "string"
}
]
}, - "github_workflows": {
- "workflows": [
- {
- "file_name": "string",
- "file_path": "string",
- "jobs": [
- {
- "id": "string",
- "name": "string",
- "permissions": [
- null
], - "actions": [
- null
], - "unpinned_runner_version": {
- "name": null,
- "version": null,
- "line_number": null
}, - "script_injection_detected": [
- null
], - "unpinned_commit_sha_actions": [
- null
], - "unverified_gh_actions": [
- null
], - "cloud_resource_accessed_without_oidc": [
- null
], - "untrusted_code_execution": [
- null
]
}
], - "permissions": [
- "GH_TOKEN_PERMISSION_UNSPECIFIED"
], - "all_secrets_exposed": [
- {
- "line_content": "string",
- "evidence": "string",
- "location_uri": "string"
}
]
}
]
}, - "pr_security_review_result_info": {
- "llm_context": {
- "structured_content": {
- "data": "string",
- "schema": { }
}, - "unstructured_content": "string"
}, - "file_changes": {
- "property1": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}, - "property2": {
- "path": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "changed_functions": [
- {
- "name": "string",
- "description": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "security_label": "string"
}
], - "purpose": "string",
- "code_change_description": [
- {
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "description": "string",
- "line": 0,
- "line_end": 0
}
], - "added_lines": 0,
- "removed_lines": 0
}
}, - "changes_description": "string",
- "security_metrics": [
- {
- "category": "SECURITY_REVIEW_CATEGORY_UNSPECIFIED",
- "title": "string",
- "description": "string",
- "snippets": [
- {
- "file": "string",
- "line": 0,
- "line_end": 0,
- "snippet": "string",
- "description": "string",
- "impact": "string",
- "change_kind": "CHANGE_KIND_UNSPECIFIED",
- "language": "string"
}
], - "severity_level": "SECURITY_SEVERITY_LEVEL_UNSPECIFIED",
- "justification": "string",
- "confidence_level": "SECURITY_REVIEW_CONFIDENCE_LEVEL_UNSPECIFIED",
- "confidence_justification": "string"
}
], - "security_description": "string"
}
}
}, - "raw": { }
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteMetric
Deletes a metric specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListMetrics
Lists all metrics associated with a given parent.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
parent_kind required | string The parent object is optional for the APIs that have such a parent relationship. |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "type": "string",
- "enabled": true,
- "category": [
- "string"
], - "options": { }
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
UpdateNamespace
Updates a provided namespace based on its UUID.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Namespace provides a mechanism for isolating groups of resources. Namespaces may be defined in a parent child hierarchy. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "managed": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "full_name": "string",
- "managed": true
}
}
UpdateNamespace
Updates a provided namespace based on its UUID.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
object.uuid required | string The UUID of a namespace. |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Namespace provides a mechanism for isolating groups of resources. Namespaces may be defined in a parent child hierarchy. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "managed": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "full_name": "string",
- "managed": true
}
}
ListNamespaces
Lists all namespaces in a tenant.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "full_name": "string",
- "managed": true
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateNamespace
Creates a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespaces are associated with a tenant.) Namespaces are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1NamespaceSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "managed": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "full_name": "string",
- "managed": true
}
}
GetNamespace
Fetches a namespace identified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "full_name": "string",
- "managed": true
}
}
DeleteNamespace
Deletes a namespace based on its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateNotification
Updates the notification.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The record created when there is a policy violation. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "hashsum": "string",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListNotifications
List all notifications.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- null
]
}, - "property2": {
- "uuids": [
- null
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "hashsum": "string",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateNotification
Creates a notification.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Notifications are associated with a tenant.) Notifications are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1NotificationSpec) |
object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "hashsum": "string",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetNotification
Fetches the notification identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "hashsum": "string",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteNotification
Deletes the notification specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateNotificationAction
Runs the action for a notification target in the server.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant metadata restrict access to a specific tenant.) The tenant metadata restrict access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1NotificationActionSpec) | |
object (v1NotificationActionResponse) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "notification": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}, - "notification_target_uuid": "string",
- "operation": "NOTIFICATION_PLUGIN_OPERATION_UNSPECIFIED"
}, - "response": {
- "result": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "notification": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "state": "NOTIFICATION_STATE_UNSPECIFIED",
- "project_uuid": "string",
- "policy_uuid": "string",
- "payload": {
- "policy_output": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "notification_action_data": {
- "property1": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}, - "property2": {
- "open_action_complete": true,
- "update_action_complete": true,
- "resolve_action_complete": true,
- "metadata": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "error_status": "string",
- "is_ignored": true,
- "notification_target_type": "ACTION_TYPE_UNSPECIFIED"
}
}, - "hashsum": "string",
- "last_seen_at": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "dismiss": {
- "time": "2019-08-24T14:15:22Z",
- "category": "NOTIFICATION_DISMISS_CATEGORY_UNSPECIFIED",
- "comment": "string"
}, - "aggregation_details": {
- "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "aggregation_target_name": "string",
- "pkg_version_uuid": "string"
}, - "diff": {
- "new_finding_uuids": [
- "string"
], - "resolved_finding_uuids": [
- "string"
]
}, - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "finding_details": {
- "property1": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}, - "property2": {
- "description": "string",
- "explanation": "string",
- "summary": "string",
- "dependency": "string",
- "package_version": "string"
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}, - "notification_target_uuid": "string",
- "operation": "NOTIFICATION_PLUGIN_OPERATION_UNSPECIFIED"
}, - "response": {
- "result": {
- "data": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
UpdateNotificationTarget
Updates a notification target.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Indicates actions taken when a corresponding notification is raised. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string",
- "access_token": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
ListNotificationTargets
Lists all notification targets.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string",
- "access_token": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateNotificationTarget
Creates a notification target.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Notification Targets are associated with a tenant.) Notification Targets are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1NotificationTargetSpec) |
propagate | boolean Indicates whether the object should be visible in the child namespaces or not. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string",
- "access_token": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
GetNotificationTarget
Fetches the notification target identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "action": {
- "action_type": "ACTION_TYPE_UNSPECIFIED",
- "public": true,
- "exclude_endor_url": true,
- "jira_config": {
- "url": "string",
- "user_name": "string",
- "api_key": "string",
- "project_key": "string",
- "issue_type": "JIRA_ISSUE_TYPE_UNSPECIFIED",
- "labels": [
- "string"
], - "jira_issue_type": "string",
- "custom_fields": [
- {
- "key": "string",
- "value": "string"
}
], - "resolve_state": "string",
- "use_bearer_token": true,
- "bearer_token": "string"
}, - "webhook_config": {
- "url": "string",
- "auth_method": "WEBHOOK_AUTH_METHOD_UNSPECIFIED",
- "basic_auth": {
- "username": "string",
- "password": "string"
}, - "api_key": "string",
- "disable_hmac": true,
- "hmac_shared_secret": "string"
}, - "email_config": {
- "receivers_addresses": [
- "string"
]
}, - "vanta_config": {
- "auth_method": "VANTA_AUTH_METHOD_UNSPECIFIED",
- "vulnerable_component_resource_id": "string",
- "package_vulnerability_resource_id": "string",
- "sca_resource_id": "string",
- "access_token_auth": {
- "client_id": "string",
- "client_secret": "string",
- "access_token": "string"
}, - "api_key": "string"
}, - "slack_config": {
- "webhook_url": "string"
}, - "github_pr_config": {
- "enabled": true
}
}, - "custom_template": {
- "template_type": "CUSTOM_TEMPLATE_TYPE_UNSPECIFIED",
- "prcomments_template": {
- "findings_summary_template": "string"
}, - "email_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}, - "slack_template": {
- "open_action_template": "string",
- "update_action_template": "string"
}, - "webhook_template": {
- "open_action_template": "string",
- "update_action_template": "string",
- "resolve_action_template": "string"
}
}
}, - "propagate": true
}
DeleteNotificationTarget
Deletes the notification target specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateOnboard
Creates an onboard. A root folder will be created along the onboard. The folder will have the same name as the onboard.
Request Body schema: application/jsonrequired
Onboard initiates the onboarding of a new tenant in the system.
object (v1Meta) Common fields for all Endor Labs resources. | |
required | object (v1OnboardSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "tenant": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}, - "user": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}, - "invitation_uuid": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "tenant": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}, - "user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}, - "invitation_uuid": "string"
}
}
UpdateOnPremScheduler updates the specified onprem scheduler.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "scheduler_version": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "helm_values": "string",
- "scheduler_version": "string"
}
}
ListOnPremSchedulers returns a list of onprem schedulers in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "helm_values": "string",
- "scheduler_version": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOnPremScheduler creates an onprem scheduler.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Contains the namespace.) Contains the namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1OnPremSchedulerSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "scheduler_version": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "helm_values": "string",
- "scheduler_version": "string"
}
}
GetOnPremScheduler returns an onprem scheduler specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "scheduler_config": {
- "image": "string",
- "tag": "string",
- "max_running_jobs": 0
}, - "endorctl_config": {
- "image": "string",
- "tag": "string",
- "max_duration": 0
}, - "api_credentials": {
- "key": "string",
- "secret": "string"
}, - "gcp": {
- "service_account": "string"
}, - "azure": {
- "enable_managed_identity": true,
- "managed_identity_client_id": "string"
}, - "use_bazel_cache": true,
- "connection_status": {
- "connection_state": "CONNECTION_STATE_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}, - "helm_values": "string",
- "scheduler_version": "string"
}
}
DeleteOnPremScheduler deletes an onprem scheduler specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationAllowedWorkflows
Updates the allowed workflows object of an organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents the information of allowed workflows of an organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationAllowedWorkflows
Lists all allowed workflows objects of an organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationAllowedWorkflows
Creates an organization allowed workflows object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationAllowedWorkflows are associated to a tenant.) OrganizationAllowedWorkflows are associated to a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationAllowedWorkflowsSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationAllowedWorkflows
Fetches the allowed workflows object of an organization identified by the UUID
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationAllowedWorkflows
Deletes an allowed workflows object of an organization identified by the UUID
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationBlockList
Updates the blocked user list of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents the information about the blocked user list of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationBlockLists
Lists the blocked user lists of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationBlockList
Creates a blocked user list of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Organization's block list is associated to a tenant.) Organization's block list is associated to a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationBlockListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationBlockList
Fetches the blocked user list of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationBlockList
Deletes the blocked user list a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationCICDPermissions
Updates the CI/CD permissions object of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Capture the permissions policy configuration for repositories. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationCICDPermissions
Lists CI/CD permissions objects of multiple organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
OrganizationCICDPermissions
Creates a CI/CD permissions object of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationCICDPermissions is associated with a tenant.) OrganizationCICDPermissions is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationCICDPermissionsSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationCICDPermissions
Fetches the permissions objects of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationCICDPermissions
Deletes the CI/CD permissions objects of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationCustomPermissionList
Updates the custom fine grained permissions of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents the ingested information about the custom fine grained permissions of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationCustomPermissionLists
Lists the custom fine grained permissions of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationCustomPermissionList
Creates custom fine grained permissions of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Organization custom permission list is associated with a tenant.) Organization custom permission list is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationCustomPermissionListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationCustomPermissionList
Lists the custom fine grained permissions of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationCustomPermissionList
Deletes the custom fine grained permissions of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationCustomRoleList
Updates the custom role list of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationCustomRoleList represents the information about a platform organization's custom roles. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationCustomRoleLists
Lists the custom role lists of multiple organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationCustomRoleList//
Creates a custom role list of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationCustomRoleList is associated with a tenant.) OrganizationCustomRoleList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationCustomRoleListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationCustomRoleList
Fetches the custom role list of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationCustomRoleList
Deletes the custom role list of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationHook
Updates an organization hook.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationHook represents the information of hooks created for an organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationHooks
Lists the organization hooks.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationHook
Creates an organization hook.
The creation of the resource will be an upsert if the given spec.external_id is already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Organization hooks are associated with a tenant.) Organization hooks are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1OrganizationHookSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationHook
Fetches an organization hook.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationHook
Deletes an organization hook.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationInstallationList
Updates the installation information of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationInstallationList represents the ingested information about the installation information of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationInstallationLists
Lists the installation information of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationInstallationList
Creates the installation information of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationInstallationList is associated with a tenant.) OrganizationInstallationList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationInstallationListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationInstallationList
Fetches the installation information of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationInstallationList
Deletes the installation information of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationInvitationList
Updates invitations of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationInvitationList represents the ingested information about invitations of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationInvitationLists
Lists the invitations of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationInvitationList
Creates invitations of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationInvitationList is associated with a tenant.) OrganizationInvitationList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationInvitationListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationInvitationList
Fetches invitations of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationInvitationList
Deletes invitations of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationMemberList
Updates the members of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationMemberList represents the ingested information about members of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationMemberLists
Lists the members of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationMemberList
Creates the members of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationMemberList is associated with a tenant.) OrganizationMemberList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationMemberListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationMemberList
Fetches the members of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationMemberList
Deletes the members of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationOutsideCollaboratorList
Updates outside collaborators of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationOutsideCollaboratorList represents the ingested information about outside collaborators of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationOutsideCollaboratorLists
Lists outside collaborators of platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationOutsideCollaboratorList
Creates outside collaborators of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationOutsideCollaboratorList is associated with a tenant.) OrganizationOutsideCollaboratorList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationOutsideCollaboratorListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationOutsideCollaboratorList
Fetches outside collaborators of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationOutsideCollaboratorList
Deletes outside collaborators of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationRunnerGroupConfig
Updates the runner group configuration of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationRunnerGroupConfig represents the ingested information about a self-hosted runner group configuration of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationRunnerGroupConfig
Lists the runner group configurations of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationRunnerGroupConfig
Creates the runner group configuration of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationRunnerGroupConfig is associated with a tenant.) OrganizationRunnerGroupConfig is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationRunnerGroupConfigSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationRunnerGroupConfig
Fetches the runner group configuration of a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationRunnerGroupConfig
Deletes the runner group configuration of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationSecurityManagerList
Updates security managers of a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationSecurityManagerList represents the ingested information about security managers of a platform organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationSecurityManagerLists
Lists security managers of multiple platform organizations.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationSecurityManagerList
Creates security managers of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationSecurityManagerList is associated with a tenant.) OrganizationSecurityManagerList is associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationSecurityManagerListSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationSecurityManagerList
Fetches security managers of a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationSecurityManagerList
Deletes security managers of a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateOrganizationWorkflowPermissions
Updates workflow permissions of an organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object OrganizationWorkflowPermissions represents the information of workflow permissions for an organization. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListOrganizationWorkflowPermissions
Lists workflow permissions of an organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateOrganizationWorkflowPermissions
Creates a workflow permissions object of an organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (OrganizationWorkflowPermissions are associated wtih a tenant.) OrganizationWorkflowPermissions are associated wtih a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1OrganizationWorkflowPermissionsSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetOrganizationWorkflowPermissions
Fetches the workflow permissions object of an organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteOrganizationWorkflowPermissions
Deletes workflow permissions of an organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateOSSDependencyRequest
Creates an OSS dependency request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (SBOM are associated with a tenant and the tenant information must be provided.) SBOM are associated with a tenant and the tenant information must be provided. |
required | object (v1OSSDependencyRequestSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
]
}
}
UpdatePackage
Updates a specified package.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Package represents a package of a project. For Golang: Every golang package of a repository will be an package. For instance github.com/yarpc/yarpc-go/pkg/encoding is a package of the project github.com/yarpc/yarpc-go. For Java: Every artifact of a Java repository will be a package. For instance github.com/apache/logging-log4j2/log4j-api is a package of the project github.com/apache/logging-log4j2. The uuid of the parent project. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
ListPackages
Lists all packages in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePackage
Creates a package.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Packages are associated with a tenant.) Packages are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1PackageSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
GetPackage
Fetches a package specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "registry_url": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
DeletePackage
Deletes a package specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdatePackageManager
Updates a specified package manager.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PackageManager holds the data for the various package managers of the enterprise. Mainly locations and access credentials when needed to resolve/scan packages from private package managers. An enterprise can create one or more package managers in a namespace. All the package managers of the given namespace will be taken into account when resolving. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "error_message": "string",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
ListPackageManagers
Lists all package managers in a given namespace
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "error_message": "string",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePackageManager
Creates a package manager in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Git repositories are associated tenant.) Git repositories are associated tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PackageManagerSpec) |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "error_message": "string",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
GetPackageManager
Fetches the package manager identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "auth_provider": {
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "aws": {
- "domain": "string",
- "domain_owner": "string",
- "repository": "string",
- "target_role_arn": "string",
- "allowed_audience": "string",
- "region": "string"
}
}, - "npm": {
- "priority": 0,
- "url": "string",
- "token": "string",
- "scope": "string",
- "auth_token": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "mvn": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "id": "string",
- "name": "string",
- "snapshots": true,
- "is_plugin_repository": true,
- "region": "string",
- "public_repository": true,
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cargo": {
- "priority": 0,
- "url": "string",
- "token": "string"
}, - "pypi": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "gem": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "nuget": {
- "priority": 0,
- "url": "string",
- "user": "string",
- "password": "string"
}, - "packagist": {
- "auth_kind": "AUTH_KIND_UNSPECIFIED",
- "host": "string",
- "user": "string",
- "password": "string"
}, - "gradle": {
- "property_key_name": "string",
- "property_key_value": "string",
- "mtls": {
- "client_cert": "string",
- "client_key": "string",
- "server_cert": "string",
- "ca_cert": "string"
}
}, - "cocoapod": {
- "priority": 0,
- "url": "string"
}, - "package_manager_status": {
- "state": "STATE_UNSPECIFIED",
- "error_message": "string",
- "last_tested_at": "2019-08-24T14:15:22Z"
}
}, - "propagate": true
}
DeletePackageManager
Deletes a package manager specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdatePackageVersion
Updates a specified package version.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PackageVersion represents a version of a package. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": "OP_UNSPECIFIED",
- "major": "string",
- "minor": "string",
- "patch": "string",
- "pre": "string"
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": {
- "expr": { }
}, - "all": {
- "expr": [
- null
]
}, - "any": {
- "expr": [
- null
]
}, - "value": {
- "name": "string",
- "pair": {
- "key": null,
- "value": null
}
}
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": "OP_UNSPECIFIED",
- "major": "string",
- "minor": "string",
- "patch": "string",
- "pre": "string"
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": {
- "expr": { }
}, - "all": {
- "expr": [
- { }
]
}, - "any": {
- "expr": [
- { }
]
}, - "value": {
- "name": "string",
- "pair": {
- "key": "string",
- "value": "string"
}
}
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListPackageVersions
Lists all the package versions in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": null,
- "major": null,
- "minor": null,
- "patch": null,
- "pre": null
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": null,
- "all": null,
- "any": null,
- "value": null
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": null,
- "name": null,
- "version": null,
- "exclude": null
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": null,
- "file_locations": [ ]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePackageVersion
Creates a package version.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (PackageVersions are associated with a tenant.) PackageVersions are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PackageVersionSpec) |
object (v1ProcessingStatus) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": "OP_UNSPECIFIED",
- "major": "string",
- "minor": "string",
- "patch": "string",
- "pre": "string"
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": {
- "expr": { }
}, - "all": {
- "expr": [
- { }
]
}, - "any": {
- "expr": [
- { }
]
}, - "value": {
- "name": "string",
- "pair": {
- "key": "string",
- "value": "string"
}
}
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": "OP_UNSPECIFIED",
- "major": "string",
- "minor": "string",
- "patch": "string",
- "pre": "string"
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": {
- "expr": { }
}, - "all": {
- "expr": [
- { }
]
}, - "any": {
- "expr": [
- { }
]
}, - "value": {
- "name": "string",
- "pair": {
- "key": "string",
- "value": "string"
}
}
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetPackageVersion
Fetches a package version specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "source_code_reference": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "http_clone_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED"
}, - "release_timestamp": "2019-08-24T14:15:22Z",
- "unresolved_dependencies": [
- {
- "maven": {
- "group_id": "string",
- "artifact_id": "string",
- "version_constraints": "string",
- "exclusions": "string",
- "scope": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "optional": true,
- "type": "string",
- "classifier": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "go": {
- "package": "string",
- "ref": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "cargo": {
- "name": "string",
- "source": "string",
- "req": [
- {
- "op": "OP_UNSPECIFIED",
- "major": "string",
- "minor": "string",
- "patch": "string",
- "pre": "string"
}
], - "kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "optional": true,
- "uses_default_features": true,
- "features": [
- "string"
], - "named": {
- "name": "string"
}, - "cfg": {
- "expr": {
- "not": {
- "expr": { }
}, - "all": {
- "expr": [
- { }
]
}, - "any": {
- "expr": [
- { }
]
}, - "value": {
- "name": "string",
- "pair": {
- "key": "string",
- "value": "string"
}
}
}
}, - "rename": "string",
- "registry": "string",
- "path": "string",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "version_constraints": "string"
}, - "pypi": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "package_manager_type": "PACKAGE_MANAGER_TYPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "npm": {
- "name": "string",
- "version": "string",
- "version_constraint": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "gem": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "nuget": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "packagist": {
- "name": "string",
- "version_constraints": "string",
- "scope_type": "SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "githubaction": {
- "name": "string",
- "version": "string",
- "scope": "SCOPE_UNSPECIFIED",
- "action_type": "GH_ACTION_TYPE_UNSPECIFIED"
}, - "cocoapod": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}, - "hugging_face": {
- "name": "string",
- "version": "string"
}, - "c": {
- "name": "string",
- "version_constraints": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
]
}
}
], - "resolved_dependencies": {
- "resolution_timestamp": "2019-08-24T14:15:22Z",
- "dependency_graph": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "dependencies": [
- {
- "name": "string",
- "public": true,
- "source_repository_http_clone_url": "string",
- "source_repository_ref": "string",
- "release_date": "2019-08-24T14:15:22Z",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "maven_dependency_scope": "SCOPE_UNSPECIFIED",
- "rust_dependency_kind": "DEPENDENCY_KIND_UNSPECIFIED",
- "golang_dependency_scope": "SCOPE_UNSPECIFIED",
- "js_dependency_scope": "SCOPE_UNSPECIFIED",
- "pypi_dependency_scope": "SCOPE_UNSPECIFIED",
- "gem_dependency_scope": "SCOPE_UNSPECIFIED",
- "nuget_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "packagist_dependency_scope": "SCOPE_UNSPECIFIED",
- "github_action_kind": "SCOPE_UNSPECIFIED",
- "cocoapod_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "hugging_face_dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "dependency_scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "pinned": true,
- "abstract": true,
- "targets": [
- {
- "type": "TARGET_TYPE_UNSPECIFIED",
- "name": "string",
- "version": "string",
- "exclude": true
}
], - "vendored": true,
- "imported_type": "IMPORTED_TYPE_UNSPECIFIED",
- "file_locations": [
- "string"
], - "container_layers": [
- {
- "digest": "string",
- "file_locations": [
- "string"
]
}
], - "patched": true,
- "purl": "string"
}
], - "dependency_files": [
- {
- "path": "string"
}
]
}, - "resolution_errors": {
- "unresolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "resolved": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}, - "call_graph": {
- "status_error": "STATUS_ERROR_UNSPECIFIED",
- "target": "string",
- "description": "string",
- "operation": "string",
- "target_files": {
- "property1": "string",
- "property2": "string"
}
}
}, - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "package_name": "string",
- "language": "LANGUAGE_UNSPECIFIED",
- "relative_path": "string",
- "container_metadata": {
- "digest": "string",
- "layers": [
- {
- "digest": "string",
- "command": "string",
- "base_layer": true
}
], - "base_image": {
- "name": "string"
}, - "distribution": "string",
- "version": "string"
}, - "bazel_metadata": {
- "build_path": "string"
}, - "code_owners": {
- "owners": [
- "string"
], - "labels": [
- "string"
]
}, - "call_graph_available": true
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeletePackageVersion
Deletes a package version specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListPackageVersionsMetadata
Lists all the package versions in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePackageVersionsMetadata
Creates a package version metadata.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (PackageVersions are associated with a tenant.) PackageVersions are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PackageVersionMetadataSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}
GetPackageVersionsMetadata
Fetches a package version metadata specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "versions": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}
DeletePackageVersionsMetadata
Deletes a package version metadata specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
Creates a package version metadata query.
When sending the request, you can choose to give a version for the package. The result of the request will be different based on this though.
While not giving the version, only the version and release time of the package versions found will be returned. While giving the version, all attributes of the version metadata will be returned.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Queries are supported only in the open source ecosystem.) Queries are supported only in the open source ecosystem. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PackageVersionMetadataQuerySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "requests": [
- {
- "package_name": "string",
- "version": "string"
}
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "requests": [
- {
- "package_name": "string",
- "version": "string",
- "found": true,
- "version_metadata": [
- {
- "version": "string",
- "release_time": "2019-08-24T14:15:22Z",
- "license": [
- "string"
], - "checksums": [
- {
- "value": "string",
- "algorithm": "HASH_ALGORITHM_UNSPECIFIED"
}
], - "source_code_url": "string",
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "source_code_ref": "string",
- "last_updated": "2019-08-24T14:15:22Z",
- "license_info": [
- {
- "name": "string",
- "spdxid": "string",
- "mapping_info": "LICENSE_MAPPING_INFO_UNSPECIFIED",
- "type": "string",
- "url": "string",
- "file": "string",
- "file_location": 0,
- "matched_text": "string"
}
], - "consumed": true
}
]
}
]
}
}
UpdatePackageVersionSourceMetadata
Updates an package version source metadata.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PackageVersionSourceMetadata contains source code information for a PackageVersion. For example, for the Java ecosystem this contains details such as checksum values of the artifact, list of class files, and their corresponding checksums and import statements found. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
ListPackageVersionSourceMetadata
Lists all the package version source metadata in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePackageVersionSourceMetadata
Creates a package version source metadata.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (PackageVersionSourceMetadata are associated with a tenant.) PackageVersionSourceMetadata are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PackageVersionSourceMetadataSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
GetPackageVersionSourceMetadata
Fetches the package version source metadata of a specified UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "artifact": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "jvm": {
- "classes": [
- {
- "name": "string",
- "checksum": {
- "sha256": "string",
- "sha512": "string"
}, - "non_metadata_checksum": {
- "sha256": "string",
- "sha512": "string"
}
}
], - "import_statements": [
- "string"
]
}, - "last_modified_time": "2019-08-24T14:15:22Z",
- "is_reconciled": true
}
}
DeletePackageVersionSourceMetadata
Deletes a package version source metadata of a specified UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdatePlatformAccount
Updates a platform account.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PlatformAccount represents an account of a user to third-party site like GitHub/Gitlab or some package platform. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListPlatformAccounts
Lists all platform accounts in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePlatformAccount
Creates a platform account. The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource were already created.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Platform accounts are associated with a tenant.
Public accounts will be under a public tenant.) Platform accounts are associated with a tenant. Public accounts will be under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1PlatformAccountSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetPlatformAccount
Fetches a platform account identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeletePlatformAccount
Deletes a platform account specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdatePlatformOrganization
Updates a platform organization.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PlatformOrganization represents an organization on a third party site like Github/Gitlab or some package platform. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListPlatformOrganizations
Lists all platform organizations in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePlatformOrganization
Creates a platform organization identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Platform organizations are associated with a tenant.) Platform organizations are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1PlatformOrganizationSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetPlatformOrganization returns a platform organization.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeletePlatformOrganization
Deletes a platform organization specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
ListPluginBinaries
Lists all the available plugin binaries.
query Parameters
filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
action | string Action to be executed with a request. Not supported for all endpoints. |
mask | string List of fields to return (all fields are returned by default). |
traverse | boolean Get data from any child namespaces as well. |
sort.path | string Field to sort objects by, for example, meta.name. |
sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
ci_run_uuid | string Only return objects from PR scans that match this context id. |
page_id | string Page ID to retrieve. |
group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": "string",
- "binary_type": "BINARY_TYPE_UNSPECIFIED",
- "arch_type": "ARCH_TYPE_UNSPECIFIED",
- "url": "string",
- "checksum": "string",
- "published_date": "2019-08-24T14:15:22Z",
- "unsupported": true,
- "compatibility_matrix": {
- "property1": {
- "min": "string",
- "max": "string"
}, - "property2": {
- "min": "string",
- "max": "string"
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePluginBinary
Creates an entry for a plugin binary.
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1PluginBinarySpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "version": "string",
- "binary_type": "BINARY_TYPE_UNSPECIFIED",
- "arch_type": "ARCH_TYPE_UNSPECIFIED",
- "url": "string",
- "checksum": "string",
- "published_date": "2019-08-24T14:15:22Z",
- "unsupported": true,
- "compatibility_matrix": {
- "property1": {
- "min": "string",
- "max": "string"
}, - "property2": {
- "min": "string",
- "max": "string"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": "string",
- "binary_type": "BINARY_TYPE_UNSPECIFIED",
- "arch_type": "ARCH_TYPE_UNSPECIFIED",
- "url": "string",
- "checksum": "string",
- "published_date": "2019-08-24T14:15:22Z",
- "unsupported": true,
- "compatibility_matrix": {
- "property1": {
- "min": "string",
- "max": "string"
}, - "property2": {
- "min": "string",
- "max": "string"
}
}
}
}
GetPluginBinary
Fetches a plugin binary identified by the UUID.
path Parameters
uuid required | string The UUID of the requested resource. |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": "string",
- "binary_type": "BINARY_TYPE_UNSPECIFIED",
- "arch_type": "ARCH_TYPE_UNSPECIFIED",
- "url": "string",
- "checksum": "string",
- "published_date": "2019-08-24T14:15:22Z",
- "unsupported": true,
- "compatibility_matrix": {
- "property1": {
- "min": "string",
- "max": "string"
}, - "property2": {
- "min": "string",
- "max": "string"
}
}
}
}
UpdatePolicy
Updates the policy.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Policy represents a policy in the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
ListPolicies
Lists all policies in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePolicy
Creates a policy.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Policies can be issued per namespace.) Policies can be issued per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PolicySpec) |
propagate | boolean Whether the object should be visible in child namespaces or not. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
GetPolicy
Fetches the policy identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "rule": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "disable": true,
- "query_statements": [
- "string"
], - "template_uuid": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_version": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}, - "notification": {
- "notification_target_uuids": [
- "string"
], - "aggregation_type": "AGGREGATION_TYPE_UNSPECIFIED",
- "bypass_exceptions": true
}, - "exception": {
- "reason": "EXCEPTION_REASON_UNSPECIFIED",
- "expiration_time": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
]
}
}, - "propagate": true
}
DeletePolicy
Deletes the policy specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdatePolicyTemplate
Updates a policy template.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object PolicyTemplate represents a policy system in the system. Policy templates can be used to create policies from these templates. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
ListPolicyTemplates
Lists all policy templates in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePolicyTemplate
Creates a policy template.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (PolicyTemplates can be issued per namespace.) PolicyTemplates can be issued per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PolicyTemplateSpec) |
propagate | boolean Whether the object should be visible in child namespaces or not. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
GetPolicyTemplate
Fetches the policy template identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": "string",
- "template_parameters": [
- {
- "value": "string",
- "description": "string",
- "possible_values": [
- "string"
], - "name": "string",
- "multiple_ok": true,
- "possible_values_from_db": {
- "resource_kind": "string",
- "input_field": "string",
- "filter": "string",
- "namespace": "string"
}, - "default_values": [
- "string"
]
}
], - "resource_kinds": [
- "string"
], - "query_statements": [
- "string"
], - "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "default_enabled": true,
- "version": "string",
- "finding_level": "FINDING_LEVEL_UNSPECIFIED",
- "group_by_fields": [
- "string"
], - "release_notes": {
- "property1": "string",
- "property2": "string"
}, - "admission": {
- "disable_enforcement": true,
- "bypass_exceptions": true
}, - "finding": {
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "summary": "string",
- "explanation": "string",
- "remediation": "string",
- "external_name": "string",
- "meta_tags": [
- "string"
], - "target_kind": "string"
}
}, - "propagate": true
}
DeletePolicyTemplate
Deletes the policy template specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreatePolicyValidation
Creates a policy validation request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant metadata restrict access to a specific tenant.) The tenant metadata restrict access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PolicyValidationSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "request": {
- "project_uuid": "string",
- "query_statements": [
- "string"
], - "rule": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_uuid": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "target_kind": "string",
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "disable_preview": true
}, - "result": {
- "policy_rule": "string",
- "query_statements": [
- "string"
], - "valid_policy": true,
- "validation_error": "string",
- "allow": true,
- "policy_output": {
- "property1": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}, - "property2": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "resource_kinds": [
- "string"
], - "evaluation_time": {
- "property1": "string",
- "property2": "string"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "request": {
- "project_uuid": "string",
- "query_statements": [
- "string"
], - "rule": "string",
- "template_values": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "template_uuid": "string",
- "project_selector": [
- "string"
], - "project_exceptions": [
- "string"
], - "resource_kinds": [
- "string"
], - "target_kind": "string",
- "policy_type": "POLICY_TYPE_UNSPECIFIED",
- "disable_preview": true
}, - "result": {
- "policy_rule": "string",
- "query_statements": [
- "string"
], - "valid_policy": true,
- "validation_error": "string",
- "allow": true,
- "policy_output": {
- "property1": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}, - "property2": {
- "violating_resources": {
- "property1": {
- "uuids": [
- "string"
]
}, - "property2": {
- "uuids": [
- "string"
]
}
}, - "raw": [
- { }
], - "allow": true
}
}, - "resource_kinds": [
- "string"
], - "evaluation_time": {
- "property1": "string",
- "property2": "string"
}
}
}
}
UpdatePRCommentConfig
Updates the the PR comment configuration.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
ListPRCommentConfigs
List all PR comment configurations for the tenant namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreatePRCommentConfig
Creates a PR comment configuration.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (PR comment configuartions are associated with a tenant.) PR comment configuartions are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1PRCommentConfigSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
GetPRCommentConfig
Fetches the PR comment configuration specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "template": {
- "findings_summary_template": "string"
}
}
}
DeletePRCommentConfig
Deletes the PR comment configuration identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateProject
Updates the specified project with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Logical root object that serves as the basis for organizing and managing all information related to a repository. A project corresponds to a repository. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "git": {
- "http_clone_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "internal_reference_key": "string",
- "git": {
- "http_clone_url": "string",
- "git_clone_url": "string",
- "organization": "string",
- "path": "string",
- "full_name": "string",
- "web_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "ingestion_token": "string",
- "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
ListProjects
Lists all projects in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "internal_reference_key": "string",
- "git": {
- "http_clone_url": "string",
- "git_clone_url": "string",
- "organization": "string",
- "path": "string",
- "full_name": "string",
- "web_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "ingestion_token": "string",
- "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateProject
Creates a project in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant to which the project belongs.) The tenant to which the project belongs. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ProjectSpec) |
object (v1ProcessingStatus) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "git": {
- "http_clone_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "internal_reference_key": "string",
- "git": {
- "http_clone_url": "string",
- "git_clone_url": "string",
- "organization": "string",
- "path": "string",
- "full_name": "string",
- "web_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "ingestion_token": "string",
- "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
GetProject
Fetches comprehensive information about a project identified by a given UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "internal_reference_key": "string",
- "git": {
- "http_clone_url": "string",
- "git_clone_url": "string",
- "organization": "string",
- "path": "string",
- "full_name": "string",
- "web_url": "string",
- "external_installation_id": "string",
- "invalid_installation": true
}, - "unsupported": {
- "name": "string"
}, - "sbom": {
- "main_component_purl": "string",
- "kind": "SBOM_KIND_UNSPECIFIED"
}, - "model": {
- "full_name": "string",
- "http_clone_url": "string",
- "provider": "AI_MODEL_PROVIDER_UNSPECIFIED"
}, - "ingestion_token": "string",
- "toolchain_profile_uuid": "string",
- "scan_profile_uuid": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}
}
DeleteProject
Deletes a project specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateProvisioningResult
Update a specified provisioning result.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ProvisioningResult represents the versions that are maintained by Endor Labs. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
ListProvisioningResults returns a list of provisioning results in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": null,
- "version": null
}
]
}, - "property2": {
- "values": [
- {
- "file": null,
- "version": null
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": { }
}, - "property2": {
- "arch": { }
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- null
], - "bazel_include_targets": [
- null
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": null,
- "property2": null
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateProvisioningResult creates a provisioning result.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Information about the tenant and namespace of the provisioning result.) Information about the tenant and namespace of the provisioning result. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1Context) Contexts keep objects from different scans separated. |
required | object (v1ProvisioningResultSpec) Spec is the internal specification of the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
GetProvisioningResult returns a provisioning result specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}, - "spec": {
- "os": "string",
- "arch": "string",
- "exit_code": 0,
- "error": "string",
- "languages_detected": [
- "string"
], - "provisioning_config": {
- "endorctl_version": "string",
- "install_build_tools": true,
- "sandbox_debug": true,
- "insecure_sandbox": true,
- "bazel_remote_cache": "string",
- "install_build_tools_dependencies": true,
- "enable_build_tools_version_detection": true,
- "use_automated_scan_parameters": true
}, - "sandbox_config": {
- "writable_paths": [
- "string"
], - "environment_variables": [
- "string"
], - "bazel_version": "string",
- "sandbox_strategy": "SANDBOX_STRATEGY_TYPE_UNSPECIFIED",
- "custom_script_config": {
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}
}
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "project_url": "string",
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}, - "property2": {
- "java_tool_chain": {
- "version": null,
- "maven_version": null,
- "gradle_version": null
}, - "python_tool_chain": {
- "version": null,
- "poetry_version": null,
- "pip_packages": { }
}, - "javascript_tool_chain": {
- "nodejs_version": null,
- "yarn_version": null,
- "pnpm_version": null,
- "npm_packages": { }
}, - "dotnet_tool_chain": {
- "version": null,
- "dotnet_installer_version": null,
- "additional_dotnet_versions": [ ]
}, - "scala_tool_chain": {
- "version": null,
- "java_version": null
}, - "golang_tool_chain": {
- "version": null
}, - "rust_tool_chain": {
- "version": null,
- "rustup_version": null,
- "mirai_version": null
}, - "android_tool_chain": {
- "command_line_tools_version": null,
- "packages": [ ]
}, - "php_tool_chain": {
- "version": null,
- "composer_version": null
}, - "ruby_tool_chain": {
- "version": null,
- "dependabot_version": null,
- "ruby_gems": { }
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}
DeleteProvisioningResult deletes a provisioning result specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateQuery
Queries metrics for specific values. It returns back a list of metric UUIDs. The caller must call the List or Get metric to retrieve the individual metric values.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The Tenant Metadata restricts access to a specific tenant.) The Tenant Metadata restricts access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1QuerySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
UpdateRepository
Updates a source control repository with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Repository represents the ingested information about a source control repository. A repository may refer to any type of source control repository, such as GitLab or GitHub. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositories
Lists the source control repositories in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepository
Creates a source control repository.
The creation of the resource will be an upsert operation if the given spec.external_id and spec.platform_resource are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repositories are associated with a tenant.
Public repositories are created as repositories under a public tenant.) Repositories are associated with a tenant. Public repositories are created as repositories under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositorySpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepository
Fetches a source control repository identified by a given UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "http_clone_url": "string",
- "owner": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "contributors": [
- "string"
], - "commit_hashes": [
- "string"
], - "languages": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tags": [
- {
- "name": "string",
- "sha": "string",
- "commit_date": "2019-08-24T14:15:22Z"
}
], - "branch_protections": {
- "property1": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "property2": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}, - "vulnerability_alerts_enabled": true,
- "default_branch": "string",
- "org": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "repository_license": {
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}, - "name": "string"
}
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepository
Deletes a source control repository specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryBranchProtection
Updates a repository branch protection with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Branch protection information of a single branch. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryBranchProtections
Lists the repository branch protections in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryBranchProtection
Creates a repository branch protection.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository branch protections are associated with a tenant.) Repository branch protections are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryBranchProtectionSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryBranchProtection
Fetches a respository branch protection identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "branch_name": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryBranchProtection
Deletes a repository branch protection specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryCheckRun
Updates a repository check run with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object RepositoryCheckRun represents the information about a repository check run. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryCheckRuns
Lists all repository check runs in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryCheckRun
Creates a repository check run.
The creation of the resource will be an upsert if the given spec.commit_sha and spec.platform_source are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository check runs are associated with a tenant.
Public repository check runs are formed under a public tenant.) Repository check runs are associated with a tenant. Public repository check runs are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryCheckRunSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryCheckRun
Fetches a repository check run identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryCheckRun
Deletes a repository check run specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryCodeownersFile
Updates a repository's codeowners file information with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The information about a repository's codeowners file. It does not contain the actual file contents. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryCodeownersFile
Lists the repository's codeowners file information in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryCodeownersFile
Creates repository codeowners file information.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Metadata required for the tenant.) Metadata required for the tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1RepositoryCodeownersFileSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryCodeownersFile
Fetches a repository's codeowners file information identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryCodeownersFile
Deletes a repository's codeowners file information.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryCollaborators
Updates a repository collaborator with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository's collaborators. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryCollaborators
Lists the repository collaborators in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryCollaborators
Creates a repository collaborator.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object Tenant related data for the tenant containing the resource. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryCollaboratorsSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryCollaborators
Fetches a repository collaborator identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "role_name": "string",
- "is_admin": true
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryCollaborators
Deletes a repository collaborator specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryCommit
Updates a repository commit with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Represents the ingested information about a repository commit. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "author": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "author": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryCommits
Lists repository commits in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "author": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryCommit
Creates a repository commit.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository commits are associated with a tenant.
Public repository commits are formed under a public tenant.) Repository commits are associated with a tenant. Public repository commits are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryCommitSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "author": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "author": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryCommit
Fetches a repository commit identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "author": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "commiter": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "hash": "string",
- "tree_hash": "string",
- "parent_hashes": [
- "string"
]
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryCommit
Deletes a repository commit specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryDeploymentEnvConfig
Updates a repository's deployment environment configuration with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository's deployment environment configurations. https://docs.github.com/en/rest/deployments/environments?apiVersion=2022-11-28#list-environments. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryDeploymentEnvConfig
Lists all repository's deployment environment configurations in the namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryDeploymentEnvConfig
Creates the repository's deployment environment configuration information.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository's deployment environment configurations are associated with a tenant.) Repository's deployment environment configurations are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1RepositoryDeploymentEnvConfigSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryDeploymentEnvConfig
Fetches a repository's deployment environment configuration identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryDeploymentEnvConfig
Deletes a rrepository's deployment environment configuration specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryHook
Updates a repository hook with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The information about hooks created for a repository. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryHooks
Lists all repository hooks in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryHook
Creates a repository hook.
The creation of the resource will be an upsert if the given spec.external_id is already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository hooks are associated with a tenant.
Public repository hooks are formed under a public tenant.) Repository hooks are associated with a tenant. Public repository hooks are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryHookSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryHook
Fetches a repository hook identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryHook
Deletes a repository hook specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryIssue
Updates a repository issue with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository issue. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryIssues
Lists all repository issues in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryIssue
Creates a repository issue.
Creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository issues are associated with a tenant.
Public repository issues are formed under a public tenant.) Repository issues are associated with a tenant. Public repository issues are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryIssueSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryIssue
Fetches a repository issue identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "assignee": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryIssue
Deletes a repository issue specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryPullRequest
Updates a repository pull request with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository pull request. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryPullRequests
Lists all repository pull requests in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryPullRequest
Creates a repository pull request.
The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository pull request are associated with a tenant.
Public repository pull requests are formed under a public tenant.) Repository pull request are associated with a tenant. Public repository pull requests are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryPullRequestSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryPullRequest
Fetches a repository pull request identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "number": 0,
- "state": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged_by_user": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "merged": true,
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "close_time": "2019-08-24T14:15:22Z",
- "merge_time": "2019-08-24T14:15:22Z",
- "requested_reviewers": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "head_commit_hash": "string",
- "merge_commit_hash": "string",
- "corrected_merge_commit_hash": "string",
- "base_commit_hash": "string",
- "name": "string",
- "summary": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryPullRequest
Deletes a repository pull request specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryRelease
Updates a repository release with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository release. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryReleases
Lists all repository releases in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryRelease
Creates a repository release.
The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository releases are associated with a tenant.
Public repository releases are formed under a public tenant.) Repository releases are associated with a tenant. Public repository releases are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryReleaseSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryRelease
Fetches a repository release identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "external_id": "string",
- "contributor": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "platform_source": "PLATFORM_SOURCE_UNSPECIFIED",
- "external_id": "string",
- "name": "string",
- "email": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}, - "tag_name": "string",
- "target_commitish": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "publish_time": "2019-08-24T14:15:22Z",
- "head_commit_hash": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryRelease
Deletes a repository release specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepository
Updates the scan metadata of a repository.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
ListRepositoryScanMetadata
Lists all scan metadata of a repository.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryScanMetadata
Creates the scan metadata of a repository.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Metrics are associated with a tenant and the tenant information must be provided.) Metrics are associated with a tenant and the tenant information must be provided. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1RepositoryScanMetadataSpec) Repository scan metadata specification. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
GetRepository
Fetches the scan meta data of a repository identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "etags": {
- "property1": "string",
- "property2": "string"
}, - "github_versions_to_scan": {
- "property1": {
- "hashes": [
- "string"
], - "total_commits": 0
}, - "property2": {
- "hashes": [
- "string"
], - "total_commits": 0
}
}
}
}
DeleteRepositoryScanMetadata
Deletes the scan metadata of a repository specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryStatus
Updates a repository status with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository status. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryStatuses
Lists all repository statuses in the given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryStatus
Creates a repository status.
The creation of the resource will be an upsert if the given spec.commit_sha and spec.platform_source are already available.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository status are associated with a tenant.
Public repository statuses are formed under a public tenant.) Repository status are associated with a tenant. Public repository statuses are formed under a public tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryStatusSpec) | |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryStatus
Fetches a repository status identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "commit_sha": "string"
}, - "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryStatus
Deletes a repository status specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryTagProtection
Updates a repository's tag protection information.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The repository's tag protections. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
ListRepositoryTagProtection
Lists all repository's tag protections information.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryTagProtection
Creates repository's tag protection information.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository's tag protections are associated with a tenant.) Repository's tag protections are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
spec | object (v1RepositoryTagProtectionSpec) |
required | object (v1IngestedObject) Raw ingested object from a 3rd party source, along with any additional metadata we want to add to the object. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
GetRepositoryTagProtection
Fetches a repository's tag protection information identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": { },
- "ingested_object": {
- "raw": { },
- "ingestion_time": "2019-08-24T14:15:22Z",
- "status": "INGESTED_OBJECT_STATUS_UNSPECIFIED"
}
}
DeleteRepositoryTagProtection
Deletes a repository's tag protection information specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRepositoryVersion
Updates a specified repository version with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object The ingested information about a repository version. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListRepositoryVersions
Lists all repository versions in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRepositoryVersion
Creates a repository version or updates a repository version if it already exists.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Repository versions are associated with a tenant.) Repository versions are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1RepositoryVersionSpec) | |
object (RepositoryVersionScanObject) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetRepositoryVersion
Fetches a repository version specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "version": {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "last_commit_date": "2019-08-24T14:15:22Z"
}, - "scan_object": {
- "status": "STATUS_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteRepositoryVersion
Deletes a repository version specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRequestAssuredPackageVersion
Updates a specified request assured package version.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object RequestAssuredPackageVersion is a request to have an assured package version patchd.. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "package_version_uuid": "string",
- "package_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
ListRequestAssuredPackageVersions
Lists all request assured package versions in a given namespace
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "package_version_uuid": "string",
- "package_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRequestAssuredPackageVersion
Creates a request assured package version in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Git repositories are associated with a tenant.) Git repositories are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1RequestAssuredPackageVersionSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "package_version_uuid": "string",
- "package_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
GetRequestAssuredPackageVersion
Fetches the request assured package version identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED",
- "contacts": [
- "string"
], - "state": {
- "status": "STATUS_UNSPECIFIED",
- "comments": [
- {
- "comment": "string",
- "time": "2019-08-24T14:15:22Z"
}
]
}, - "package_version_name": "string",
- "package_version_uuid": "string",
- "package_name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED"
}
}
DeleteRequestAssuredPackageVersion
Deletes a request assured package version specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateRuleSetImport
Updates an imported set of rules.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ImportedRuleSet represents a request to import a set of rules. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "sha256_hash": "string",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
ListRuleSetImports
Lists all imported rule set objects in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "sha256_hash": "string",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateRuleSetImport
Imports the given set of rules.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Rule set is associated with a tenant and tenant information must be provided.) Rule set is associated with a tenant and tenant information must be provided. |
object (v1ImportedRuleSetSpec) The internal specification of the object. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "sha256_hash": "string",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
GetRuleSetImport
Fetches an imported rule set object specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "rule_type": "RULE_TYPE_UNSPECIFIED",
- "sha256_hash": "string",
- "rule_source_type": "RULE_SOURCE_TYPE_UNSPECIFIED",
- "bytes": "string",
- "version": "string",
- "result": {
- "status": "IMPORTED_RULE_SET_RESULT_STATUS_UNSPECIFIED",
- "processing_time": 0.1,
- "errors": [
- "string"
]
}
}
}
DeleteRuleSetImport
Deletes an imported rule set object specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateSavedQuery
Updates the saved queries.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object SavedQuery implements the metric query requests. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "lock": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
ListSavedQueries
Lists all saved queries in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": null,
- "order": null
}, - "count": true,
- "group": {
- "aggregation_paths": null,
- "show_aggregation_uuids": null,
- "unique_count_paths": null,
- "unique_value_paths": null
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": null,
- "show_aggregation_uuids": null,
- "interval": null,
- "group_size": null,
- "start_time": null,
- "end_time": null,
- "mode": null,
- "aggregation_value_field": null,
- "aggregation_operator": null
}
}, - "with": [
- {
- "kind": null,
- "filter": null
}
], - "references": [
- {
- "connect_to": null,
- "connect_from": null,
- "connect_operator": null,
- "query_spec": null
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "lock": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSavedQuery
Creates a saved query.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The Tenant Metadata restricts access to a specific tenant.) The Tenant Metadata restricts access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1SavedQuerySpec) | |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "lock": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
GetSavedQuery
Fetches the saved query identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "lock": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
DeleteSavedQuery
Deletes the saved query specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
EvaluateSavedQuery
Evaluates the saved query, then returns the query and the result.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "query_spec": {
- "kind": "string",
- "list_parameters": {
- "filter": "string",
- "page_token": 0,
- "page_size": 0,
- "action": "string",
- "mask": "string",
- "traverse": true,
- "sort": {
- "path": "string",
- "order": "SORT_ENTRY_ORDER_UNSPECIFIED"
}, - "count": true,
- "group": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "unique_count_paths": "string",
- "unique_value_paths": "string"
}, - "ci_run_uuid": "string",
- "page_id": "string",
- "group_by_time": {
- "aggregation_paths": "string",
- "show_aggregation_uuids": true,
- "interval": "GROUP_BY_TIME_INTERVAL_UNSPECIFIED",
- "group_size": 0,
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "mode": "string",
- "aggregation_value_field": "string",
- "aggregation_operator": "string"
}
}, - "with": [
- {
- "kind": "string",
- "filter": "string"
}
], - "references": [
- {
- "connect_to": "string",
- "connect_from": "string",
- "connect_operator": "string",
- "query_spec": { }
}
], - "return_as": "string"
}, - "query_response": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "monitor": true,
- "lock": true,
- "query_type": "QUERY_TYPE_UNSPECIFIED"
}, - "propagate": true
}
CreateSBOMExport
Creates an SBOM export.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (SBOM are associated with a tenant and tenant information must be provided.) SBOM are associated with a tenant and tenant information must be provided. |
object (v1ExportedSBOMSpec) The internal specification of the object. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "kind": "SBOM_KIND_UNSPECIFIED",
- "format": "FORMAT_UNSPECIFIED",
- "component_type": "COMPONENT_TYPE_UNSPECIFIED",
- "hide_private_components": true,
- "export_parameters": {
- "project_uuid": "string",
- "project_name": "string",
- "package_version_uuids": [
- { }
], - "repository_version": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "data": "string",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "format": "FORMAT_UNSPECIFIED",
- "component_type": "COMPONENT_TYPE_UNSPECIFIED",
- "hide_private_components": true,
- "export_parameters": {
- "project_uuid": "string",
- "project_name": "string",
- "package_version_uuids": [
- { }
], - "repository_version": "string"
}
}
}
UpdateSBOMImport
Updates an imported SBOM.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ImportedSBOM represents an SBOM that has been imported. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "kind": "SBOM_KIND_UNSPECIFIED",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "identifier": "string",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "version": 0,
- "main_component_purl": "string",
- "supplier_name": "string",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListSBOMImports
Lists all imported SBOMS in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "identifier": "string",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "version": 0,
- "main_component_purl": "string",
- "supplier_name": "string",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSBOMImport
Imports the given SBOM.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (SBOM are associated with a tenant and tenant information must be provided.) SBOM are associated with a tenant and tenant information must be provided. |
object (v1ImportedSBOMSpec) The internal specification of the object. | |
object (v1ProcessingStatus) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "kind": "SBOM_KIND_UNSPECIFIED",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "identifier": "string",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "version": 0,
- "main_component_purl": "string",
- "supplier_name": "string",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetSBOMImport
Fetches an imported SBOM specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "identifier": "string",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "version": 0,
- "main_component_purl": "string",
- "supplier_name": "string",
- "cyclone_dx": "string",
- "spdx": "string",
- "cyclone_dx_bytes": "string",
- "spdx_bytes": "string"
}, - "processing_status": {
- "scan_state": "SCAN_STATE_UNSPECIFIED",
- "scan_time": "2019-08-24T14:15:22Z",
- "analytic_time": "2019-08-24T14:15:22Z",
- "queue_time": "2019-08-24T14:15:22Z",
- "disable_automated_scan": true,
- "metadata": {
- "full_history_scan_time": "2019-08-24T14:15:22Z"
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteSBOMImport
Deletes an imported SBOM specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateSBOMOrganizationalContact
Updates an SBOM organizational contact.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
ListSBOMOrganizationalContacts
Lists all SBOM organizational contacts in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSBOMOrganizationalContact
Creates an SBOM organizational contact.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1Meta) Common fields for all Endor Labs resources. | |
tenant_meta | object (SBOM organizational contacts are associated with a tenant and tenant information must be provided.) SBOM organizational contacts are associated with a tenant and tenant information must be provided. |
required | object (v1SBOMOrganizationalContactSpec) The internal specification of the object. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
GetSBOMOrganizationalContact
Fetches an SBOM organizational contact specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
DeleteSBOMOrganizationalContact
Deletes an SBOM organizational contact specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateScanLogRequest
Create a scan log request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the message that is accessed.) Namespace of the message that is accessed. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ScanLogRequestSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "max_entries": 0,
- "newest_first": true,
- "admin_filter": "string",
- "log_levels": [
- "LOG_LEVEL_UNSPECIFIED"
], - "scan_request_uuid": "string",
- "project_uuid": "string",
- "installation_uuid": "string",
- "onprem_scheduler_uuid": "string",
- "scan_result_uuid": "string",
- "execution_id": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "start_time": "2019-08-24T14:15:22Z",
- "max_entries": 0,
- "log_messages": [
- {
- "level": "LOG_LEVEL_UNSPECIFIED",
- "json_payload": { },
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
], - "newest_first": true,
- "admin_filter": "string",
- "log_levels": [
- "LOG_LEVEL_UNSPECIFIED"
], - "scan_request_uuid": "string",
- "project_uuid": "string",
- "installation_uuid": "string",
- "onprem_scheduler_uuid": "string",
- "scan_result_uuid": "string",
- "execution_id": "string",
- "applied_filter": "string"
}
}
UpdateScanProfile updates a specified Toolchain profile.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ScanProfile represents the scan configuration to use across different projects. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
ListScanProfiles returns a list of toolchain profiles in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScanProfile creates a toolchain profile.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object Tenant related data for the tenant containing the resource. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ScanProfileSpec) Spec is the internal specification of the object. |
propagate | boolean Indicates that the object should be visible in the child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
GetScanProfile returns a toolchain profile specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "property2": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
DeleteScanProfile deletes a toolchain profile specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateScanRequest
Updates a scan request with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ScanRequest represents a request to scan a particular PR and is only used by the system. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "scheduled_time": "2019-08-24T14:15:22Z",
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string",
- "is_on_premise": true
}
}
ListScanRequests
Lists the scan requests in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "scheduled_time": "2019-08-24T14:15:22Z",
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string",
- "is_on_premise": true
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScanRequest
Creates a scan request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (ScanRequests are associated with a tenant.) ScanRequests are associated with a tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1ScanRequestSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "scheduled_time": "2019-08-24T14:15:22Z",
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string",
- "is_on_premise": true
}
}
GetScanRequest
Fetches a scan request identified by a given UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "installation_uuid": "string",
- "pull_request_id": "string",
- "commit_sha": "string",
- "ref": "string",
- "status": "SCAN_REQUEST_STATUS_UNSPECIFIED",
- "result": {
- "ci_run_uuid": "string",
- "status": "SCAN_REQUEST_RESULT_STATUS_UNSPECIFIED",
- "scan_time": 0.1
}, - "external_scm_reference": "string",
- "pr_run_uuid": "string",
- "origin": "SCAN_REQUEST_ORIGIN_UNSPECIFIED",
- "request_full_scan": true,
- "request_pr_comments": true,
- "scheduled_time": "2019-08-24T14:15:22Z",
- "type": "SCAN_REQUEST_TYPE_UNSPECIFIED",
- "tenant_name": "string",
- "is_on_premise": true
}
}
DeleteScanRequest
Deletes a scan request specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateScanResult
Update a specified scan result.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object Contains the results of an endorctl scan. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "scan_profile": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": null,
- "property2": null
}
}, - "property2": {
- "arch": {
- "property1": null,
- "property2": null
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [ ],
- "assignees": [ ],
- "labels": [ ]
}, - "property2": {
- "reviewers": [ ],
- "assignees": [ ],
- "labels": [ ]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListScanResults
List scan results based on the specified list parameters.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "maven_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "gradle_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "python_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "poetry_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pip_packages": {
- "property1": null,
- "property2": null
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "yarn_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "pnpm_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "npm_packages": {
- "property1": null,
- "property2": null
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dotnet_installer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "additional_dotnet_versions": [
- null
]
}, - "scala_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "java_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "golang_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "rust_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "rustup_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "mirai_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "packages": [
- null
]
}, - "php_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "composer_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}, - "ruby_tool_chain": {
- "version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "dependabot_version": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "ruby_gems": {
- "property1": null,
- "property2": null
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- null
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}, - "property2": {
- "name": null,
- "relative_tool_chain_path": null,
- "urls": [ ],
- "sha256_sum": null
}
}
}
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": null,
- "property2": null
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- null
], - "excluded_paths": [
- null
], - "languages": [
- null
], - "call_graph_languages": [
- null
], - "bazel_configuration": {
- "bazel_exclude_targets": [ ],
- "bazel_include_targets": [ ],
- "bazel_show_internal_targets": null,
- "bazel_targets_query": null,
- "bazel_workspace_path": null
}, - "additional_environment_variables": [
- null
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": null,
- "language_parameters": { }
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScanResult
Create a scan result.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Information about the tenant and namespace that the scan ran in.) Information about the tenant and namespace that the scan ran in. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1ScanResultSpec) ScanResult specific data. | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "scan_profile": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetScanResult
Return a specified scan result.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "errors": [
- "string"
], - "warnings": [
- "string"
], - "infos": [
- "string"
], - "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "stats": {
- "property1": 0,
- "property2": 0
}, - "type": "TYPE_UNSPECIFIED",
- "refs": [
- "string"
], - "environment": {
- "tools": [
- {
- "name": "string",
- "version": "string"
}
], - "arch": "string",
- "endorctl_version": "string",
- "config": { },
- "os": "string",
- "memory": 0.1,
- "num_cpus": 0
}, - "has_panic": true,
- "exit_code": "ENDORCTL_RC_UNSPECIFIED",
- "logs": [
- "string"
], - "policies_triggered": [
- "string"
], - "warning_findings": [
- "string"
], - "blocking_findings": [
- "string"
], - "runtimes": {
- "property1": 0,
- "property2": 0
}, - "all_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "deleted_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "languages_detected": [
- "string"
], - "exception_findings": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "approximation": true,
- "create_time": "2019-08-24T14:15:22Z",
- "target_dependency_package_name": "string"
}
}, - "findings": [
- "string"
], - "provisioning_result_uuid": "string",
- "versions": [
- {
- "sha": "string",
- "ref": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
], - "provisioning_result": {
- "provisioning_result_uuid": "string",
- "exit_code": 0,
- "error": "string",
- "automated_scan_parameters_config": {
- "automated_scan_parameters_source": "AUTOMATED_SCAN_PARAMETERS_SOURCE_UNSPECIFIED",
- "resolved_scan_environment_variables": [
- "string"
]
}, - "auto_detect_result": {
- "detected_tool_chain_versions": {
- "property1": {
- "file": "string",
- "version": "string"
}, - "property2": {
- "file": "string",
- "version": "string"
}
}, - "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "error": "string",
- "detected_versions": {
- "property1": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}, - "property2": {
- "values": [
- {
- "file": "string",
- "version": "string"
}
]
}
}
}, - "tool_chains_source": "TOOL_CHAINS_SOURCE_UNSPECIFIED",
- "tool_chains": {
- "java_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "maven_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "gradle_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "python_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "poetry_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pip_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "javascript_tool_chain": {
- "nodejs_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "yarn_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "pnpm_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "npm_packages": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}, - "dotnet_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dotnet_installer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "additional_dotnet_versions": [
- "string"
]
}, - "scala_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "java_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "golang_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "rust_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "rustup_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "mirai_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "android_tool_chain": {
- "command_line_tools_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "packages": [
- "string"
]
}, - "php_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "composer_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}, - "ruby_tool_chain": {
- "version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "dependabot_version": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "ruby_gems": {
- "property1": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}, - "property2": {
- "name": "string",
- "relative_tool_chain_path": "string",
- "urls": [
- "string"
], - "sha256_sum": "string"
}
}
}
}, - "scan_profile": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "toolchain_profile": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}, - "property2": {
- "java_tool_chain": null,
- "python_tool_chain": null,
- "javascript_tool_chain": null,
- "dotnet_tool_chain": null,
- "scala_tool_chain": null,
- "golang_tool_chain": null,
- "rust_tool_chain": null,
- "android_tool_chain": null,
- "php_tool_chain": null,
- "ruby_tool_chain": null
}
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}, - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "is_default": true,
- "security_review_scanner_parameters": {
- "user_prompt": "string"
}
}, - "propagate": true
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteScanResult
Delete a specified scan result.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateScanWorkflow
Updates the specified scan workflow with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ScanWorkflow corresponds to a workflow of scan steps. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
ListScanWorkflows
Lists all scan workflows in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}, - "property2": {
- "reviewers": [
- null
], - "assignees": [
- null
], - "labels": [
- null
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScanWorkflow
Creates a scan workflow in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant to which the scan workflow belongs.) The tenant to which the scan workflow belongs. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ScanWorkflowSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
GetScanWorkflow
Fetches comprehensive information about a scan workflow identified by a given UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "steps": [
- {
- "title": "string",
- "scan_profile_uuid": "string",
- "disabled": true
}
], - "remediation_parameters": {
- "automated_pr_parameters": {
- "max_open_prs": 0,
- "language_parameters": {
- "property1": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}, - "property2": {
- "reviewers": [
- "string"
], - "assignees": [
- "string"
], - "labels": [
- "string"
]
}
}
}
}, - "automated_scan_parameters": {
- "full_pr_scan": true,
- "full_push_scan": true,
- "included_paths": [
- "string"
], - "excluded_paths": [
- "string"
], - "languages": [
- "string"
], - "call_graph_languages": [
- "string"
], - "bazel_configuration": {
- "bazel_exclude_targets": [
- "string"
], - "bazel_include_targets": [
- "string"
], - "bazel_show_internal_targets": true,
- "bazel_targets_query": "string",
- "bazel_workspace_path": "string"
}, - "additional_environment_variables": [
- "string"
], - "enable_pr_comments": true,
- "enable_remediation_action": true,
- "enable_automated_pr_scans": true,
- "enable_sast_scan": true,
- "enable_secret_scan": true,
- "enable_full_git_log_secret_scan": true,
- "disable_code_storage": true,
- "disable_code_snippet_storage": true,
- "enable_pr_security_review_scan": true
}
}
}
DeleteScanWorkflow
Deletes a scan workflow specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateScanWorkflowResult
Updates the specified scan workflow result with the information in the request body.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ScanWorkflowResult corresponds to a workflow scan result. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListScanWorkflowResults
Lists all scan workflow results in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScanWorkflowResult
Creates a scan workflow result in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant to which the scan workflow result belongs.) The tenant to which the scan workflow result belongs. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ScanWorkflowResultSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetScanWorkflowResult
Fetches comprehensive information about a scan workflow result identified by a given UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "status": "STATUS_UNSPECIFIED",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "execution_id": "string",
- "workflow_results": [
- {
- "status": "STATUS_UNSPECIFIED",
- "error": {
- "code": "ENDORCTL_RC_UNSPECIFIED",
- "error": "string"
}, - "scan_duration": "string",
- "title": "string",
- "scan_profile_uuid": "string",
- "scan_result_uuid": "string",
- "provisioning_result_uuid": "string"
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteScanWorkflowResult
Deletes a scan workflow result specified by its UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateScopePolicy
Updates the scope policy.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ScopePolicy represents a scope policy in the system. Scope policies allow users to select for a set of projects (or namespaces) as defined by the project selectors. It is the set of policies that are applied to these projects as defined by a policy selector. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
ListScopePolicies
Lists all scope policies in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateScopePolicy
Creates a scope policy.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Scope policies are issued per namespace.) Scope policies are issued per namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ScopePolicySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
GetScopePolicy
Fetches the scope policy identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_namespace_selector": [
- "string"
], - "project_tag_selector": [
- "string"
], - "excluded_project_tag_selector": [
- "string"
], - "policy_namespace_selector": [
- "string"
], - "policy_tag_selector": [
- "string"
]
}
}
DeleteScopePolicy
Deletes the scope policy specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateSecretRule
Updates a secret rule.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
ListSecretRules
Lists all secret rules in a namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSecretRule
Creates a secret rule.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Rules are associated with a tenant and namespace.) Rules are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1SecretRuleSpec) Internal specification of the object. Follows the specification of the gitleaks configuration object defined here: https://github.com/gitleaks/gitleaks/blob/master/config/rule.go |
propagate | boolean Propagate indicates that the object should be visible in children namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
GetSecretRule
Fetches the secret rule identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "description": "string",
- "rule_id": "string",
- "entropy": 0.1,
- "secret_group": 0,
- "regex": "string",
- "path": "string",
- "tags": [
- "string"
], - "keywords": [
- "string"
], - "allowlist": {
- "description": "string",
- "regexes": [
- "string"
], - "regex_target": "string",
- "paths": [
- "string"
], - "commits": [
- "string"
], - "stop_words": [
- "string"
]
}, - "disabled": true,
- "validation": {
- "name": "string",
- "description": "string",
- "h_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "http_request": {
- "uri": "string",
- "method": "string",
- "header": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "query": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "body": [
- {
- "key": "string",
- "value": "string",
- "authz": true,
- "separator": "string"
}
], - "method_name": "string"
}, - "h_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "http_response": {
- "status_code": "string",
- "invalid_code_regex": "string",
- "successful_auth_codes": [
- 0
], - "failed_auth_codes": [
- 0
]
}, - "hmac_auth": {
- "secret": "string",
- "hdr_name": "string"
}
}
}, - "propagate": true
}
DeleteSecretRule
Deletes the secret rule identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateSegmentQueryRequest
Creates a segment query request.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the segment query request.) Namespace of the segment query request. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1SegmentQueryRequestSpec) |
object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "queries": [
- {
- "signatures": [
- "string"
], - "vectors": [
- {
- "vector": [
- 0.1
]
}
], - "file_path": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "file_hash": "string"
}
], - "project_uuid": "string",
- "ref": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "queries": [
- {
- "signatures": [
- "string"
], - "vectors": [
- {
- "vector": [
- 0.1
]
}
], - "file_path": "string",
- "scope": "DEPENDENCY_SCOPE_UNSPECIFIED",
- "file_hash": "string",
- "results": [
- {
- "file": "string",
- "library": "string",
- "version": "string",
- "version_unique": "string",
- "score": 0.1,
- "aggregated_score": 0.1,
- "rank": 0,
- "release_date": "2019-08-24T14:15:22Z",
- "match_types": {
- "property1": 0,
- "property2": 0
}
}
]
}
], - "project_uuid": "string",
- "ref": "string"
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
UpdateSemgrepRule
Updates the Semgrep rule.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": null
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": null
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "defined_by": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
ListSemgrepRules
Lists all Semgrep rules in the namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- null
], - "pattern_either": [
- null
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": null
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": null,
- "metavariable": null,
- "x": null
}, - "patterns": [
- null
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- null
], - "metavariable_analysis": {
- "analyzer": null,
- "metavariable": null
}, - "focus_metavariable": [
- null
], - "metavariable_comparison": {
- "metavariable": null,
- "comparison": null,
- "base": null,
- "strip": null
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": null
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": null,
- "type": null
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": null,
- "metavariable": null,
- "x": null
}, - "patterns": [
- null
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- null
], - "metavariable_analysis": {
- "analyzer": null,
- "metavariable": null
}, - "focus_metavariable": [
- null
], - "metavariable_comparison": {
- "metavariable": null,
- "comparison": null,
- "base": null,
- "strip": null
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": null
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": null,
- "type": null
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "defined_by": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSemgrepRule
Creates a Semgrep rule.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Rules are associated with a tenant and namespace.) Rules are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1SemgrepRuleSpec) |
propagate | boolean Propagate indicates that the object should be visible in child namespaces. |
disabled | boolean |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "defined_by": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
GetSemgrepRule
Fetches a Semgrep rule identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "rule": {
- "id": "string",
- "pattern": "string",
- "fix": "string",
- "severity": "string",
- "metadata": {
- "license": "string",
- "likelihood": "string",
- "confidence": "string",
- "category": "string",
- "cwe": [
- "string"
], - "owasp": [
- "string"
], - "references": [
- "string"
], - "technology": [
- "string"
], - "subcategory": [
- "string"
], - "cwe2022_top25": true,
- "cwe2021_top25": true,
- "source_rule_url": "string",
- "impact": "string",
- "description": "string",
- "endor_targets": [
- "ENDOR_TARGET_UNSPECIFIED"
], - "endor_category": "string",
- "endor_tags": [
- "string"
], - "endor_attack_examples": [
- "string"
], - "version": "string",
- "confidence_level": "CONFIDENCE_LEVEL_UNSPECIFIED",
- "asvs": {
- "section": "string",
- "control_id": "string",
- "control_url": "string",
- "version": "string"
}, - "functional_categories": [
- "string"
], - "vulnerability": "string",
- "interfile": true,
- "security_severity": "string",
- "short_description": "string",
- "vulnerability_class": [
- "string"
], - "endor_rule_origin": {
- "url": "string",
- "license": "string"
}, - "author": "string",
- "explanation": "string",
- "remediation": "string",
- "cwe2023_top25": true,
- "rule_origin_note": "string",
- "help": "string",
- "precision": "string",
- "tags": [
- "string"
], - "source_url_open": "string",
- "cwe2020_top25": true,
- "severity": "string",
- "bandit_code": "string",
- "masvs": [
- "string"
], - "owaspapi": "string",
- "resources": [
- "string"
], - "deprecated": true,
- "display_name": "string"
}, - "languages": [
- "string"
], - "message": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "fix_regex": {
- "regex": "string",
- "replacement": "string",
- "count": 0
}, - "mode": "string",
- "pattern_sources": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_sinks": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_propagators": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "options": {
- "symbolic_propagation": true,
- "taint_unify_mvars": true,
- "generic_ellipsis_max_span": 0,
- "interfile": true,
- "taint_assume_safe_booleans": true,
- "taint_assume_safe_numbers": true,
- "taint_assume_safe_functions": true,
- "constant_propagation": true,
- "implicit_deep_exprstmt": true,
- "generic_engine": "string"
}, - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "paths": {
- "include": [
- "string"
], - "exclude": [
- "string"
]
}, - "pattern_sanitizers": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_not": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- { }
], - "pattern_either": [
- { }
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [
- null
], - "exclude": [
- null
]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "references": [
- "string"
], - "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "metavariable_pattern": {
- "metavariable": "string",
- "patterns": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_either": [
- {
- "pattern": "string",
- "pattern_not": "string",
- "from": "string",
- "to": "string",
- "metavariable_regex": {
- "regex": "string",
- "metavariable": "string",
- "x": "string"
}, - "patterns": [
- { }
], - "pattern_not_regex": "string",
- "pattern_regex": "string",
- "pattern_inside": "string",
- "pattern_not_inside": "string",
- "metavariable_pattern": { },
- "pattern_either_new": [
- { }
], - "metavariable_analysis": {
- "analyzer": "string",
- "metavariable": "string"
}, - "focus_metavariable": [
- "string"
], - "metavariable_comparison": {
- "metavariable": "string",
- "comparison": "string",
- "base": true,
- "strip": true
}, - "exact": true,
- "by_side_effect": true,
- "label": "string",
- "management": {
- "endpoints": {
- "web": {
- "exposure": {
- "include": [ ],
- "exclude": [ ]
}
}
}
}, - "not_conflicting": true,
- "requires": "string",
- "metavariable_type": {
- "metavariable": "string",
- "type": "string"
}
}
], - "pattern_regex": "string",
- "language": "string",
- "pattern": "string"
}, - "focus_metavariable": [
- "string"
], - "min_version": "string"
}, - "disabled": true,
- "yaml": "string",
- "defined_by": "string",
- "severity_level": "SEVERITY_LEVEL_UNSPECIFIED"
}, - "propagate": true,
- "disabled": true
}
DeleteSemgrepRule
Deletes the rule specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateServiceToken
Creates a new service token.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
required | object (v1Meta) Common fields for all Endor Labs resources. |
tenant_meta | object (Tenant metadata required for service tokens.) Tenant metadata required for service tokens. |
object (v1ServiceTokenSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "audience": "string",
- "expiration_time": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "audience": "string",
- "expiration_time": "2019-08-24T14:15:22Z",
- "service_token": "string"
}
}
Queries packages which is lexicographically similar to a given package.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (The tenant metadata restricts access to a specific tenant.) The tenant metadata restricts access to a specific tenant. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1QuerySimilarPackagesSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "name": "string",
- "edit_distance": 0,
- "repo": "ECOSYSTEM_UNSPECIFIED",
- "exact_match": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "name": "string",
- "edit_distance": 0,
- "repo": "ECOSYSTEM_UNSPECIFIED",
- "exact_match": true
}, - "query_response": [
- {
- "name": "string",
- "dependents_count": "string",
- "age": "string",
- "jaccard_distance": 0.1,
- "edit_distance": "string"
}
]
}
ListSupportedToolChainProfiles returns a list of toolchain profiles in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}, - "property2": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}, - "property2": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}
}
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
SupportedToolChainProfileService_GetSupportedToolChainProfile2
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}, - "property2": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}, - "property2": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}
}
}
}
}
}
ListSupportedToolChainProfiles returns a list of toolchain profiles in a specified namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}, - "property2": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}, - "property2": {
- "toolchain": {
- "property1": null,
- "property2": null
}
}
}
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
SupportedToolChainProfileService_GetSupportedToolChainProfile
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "os": {
- "property1": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}, - "property2": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}
}
}, - "property2": {
- "arch": {
- "property1": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}, - "property2": {
- "toolchain": {
- "property1": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}, - "property2": {
- "versions": [
- {
- "version": null,
- "default": null,
- "disabled": null
}
]
}
}
}
}
}
}
}
}
UpdateSystemConfig
Updates the system configuration.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object SystemConfig represents the system configuration for a tenant. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
ListSystemConfig
Returns the system configuration as a list of length 1.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateSystemConfig
Creates a system configuration object.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (SystemConfig is associated with a tenant and namespace.) SystemConfig is associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1SystemConfigSpec) |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
GetSystemConfig
Fetches the system configuration specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "policy": {
- "auto_enable": true,
- "auto_update": true
}, - "logging": {
- "enable_remote_logging": true,
- "remote_ep": "string",
- "remote_log_level": "LOG_LEVEL_UNSPECIFIED"
}, - "analytics": {
- "enable_finding_prioritization": true,
- "enable_version_upgrade_prioritization": true
}, - "finding_prioritization": {
- "factors": {
- "property1": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}, - "property2": {
- "name": "string",
- "description": "string",
- "category": "FACTOR_CATEGORY_UNSPECIFIED",
- "impact": "FACTOR_IMPACT_UNSPECIFIED"
}
}
}, - "artifactory": {
- "enable_streaming": true
}, - "sast": {
- "enable_semgrep": true
}
}, - "propagate": true
}
DeleteSystemConfig
Deletes the system configuration specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateTableRowGroup
Updates the table row group.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object TableRowGroup in the main object that contains an ordered list of TableRows and TableDescription with general information about the table. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListTableRowGroups
Lists all table row groups.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [ ]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [ ]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateTableRowGroup
Creates a table row group.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (TableRowGroups are associated with a tenant and namespace.) TableRowGroups are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1TableRowGroupSpec) |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetTableRowGroup
Fetches the table row group identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "sequence": 0,
- "header": {
- "columns": 0,
- "description": "string",
- "column_ids": {
- "property1": 0,
- "property2": 0
}, - "column_types": {
- "property1": "COLUMN_TYPES_UNSPECIFIED",
- "property2": "COLUMN_TYPES_UNSPECIFIED"
}
}, - "rows": [
- {
- "columns": {
- "property1": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}, - "property2": {
- "int_value": 0,
- "str_value": "string",
- "float_value": 0.1,
- "bool_value": true,
- "string_list_value": {
- "list_value": [
- "string"
]
}
}
}
}
]
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteTableRowGroup
Deletes the table row group specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateTelemetry
Creates a telemetry.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace of the message that is accessed.) Namespace of the message that is accessed. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1TelemetrySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "metric_families": [
- {
- "name": "string",
- "help": "string",
- "type": "COUNTER",
- "metric": [
- {
- "label": [
- {
- "name": "string",
- "value": "string"
}
], - "gauge": {
- "value": 0.1
}, - "counter": {
- "value": 0.1,
- "exemplar": {
- "label": [
- {
- "name": null,
- "value": null
}
], - "value": 0.1,
- "timestamp": "2019-08-24T14:15:22Z"
}, - "created_timestamp": "2019-08-24T14:15:22Z"
}, - "summary": {
- "sample_count": "string",
- "sample_sum": 0.1,
- "quantile": [
- {
- "quantile": 0.1,
- "value": 0.1
}
], - "created_timestamp": "2019-08-24T14:15:22Z"
}, - "untyped": {
- "value": 0.1
}, - "histogram": {
- "sample_count": "string",
- "sample_count_float": 0.1,
- "sample_sum": 0.1,
- "bucket": [
- {
- "cumulative_count": "string",
- "cumulative_count_float": 0.1,
- "upper_bound": 0.1,
- "exemplar": {
- "label": [ ],
- "value": null,
- "timestamp": null
}
}
], - "created_timestamp": "2019-08-24T14:15:22Z",
- "schema": 0,
- "zero_threshold": 0.1,
- "zero_count": "string",
- "zero_count_float": 0.1,
- "negative_span": [
- {
- "offset": 0,
- "length": 0
}
], - "negative_delta": [
- "string"
], - "negative_count": [
- 0.1
], - "positive_span": [
- {
- "offset": 0,
- "length": 0
}
], - "positive_delta": [
- "string"
], - "positive_count": [
- 0.1
], - "exemplars": [
- {
- "label": [
- null
], - "value": 0.1,
- "timestamp": "2019-08-24T14:15:22Z"
}
]
}, - "timestamp_ms": "string"
}
], - "unit": "string"
}
], - "execution_id": "string",
- "caller_prefix": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "metric_families": [
- {
- "name": "string",
- "help": "string",
- "type": "COUNTER",
- "metric": [
- {
- "label": [
- {
- "name": "string",
- "value": "string"
}
], - "gauge": {
- "value": 0.1
}, - "counter": {
- "value": 0.1,
- "exemplar": {
- "label": [
- {
- "name": null,
- "value": null
}
], - "value": 0.1,
- "timestamp": "2019-08-24T14:15:22Z"
}, - "created_timestamp": "2019-08-24T14:15:22Z"
}, - "summary": {
- "sample_count": "string",
- "sample_sum": 0.1,
- "quantile": [
- {
- "quantile": 0.1,
- "value": 0.1
}
], - "created_timestamp": "2019-08-24T14:15:22Z"
}, - "untyped": {
- "value": 0.1
}, - "histogram": {
- "sample_count": "string",
- "sample_count_float": 0.1,
- "sample_sum": 0.1,
- "bucket": [
- {
- "cumulative_count": "string",
- "cumulative_count_float": 0.1,
- "upper_bound": 0.1,
- "exemplar": {
- "label": [ ],
- "value": null,
- "timestamp": null
}
}
], - "created_timestamp": "2019-08-24T14:15:22Z",
- "schema": 0,
- "zero_threshold": 0.1,
- "zero_count": "string",
- "zero_count_float": 0.1,
- "negative_span": [
- {
- "offset": 0,
- "length": 0
}
], - "negative_delta": [
- "string"
], - "negative_count": [
- 0.1
], - "positive_span": [
- {
- "offset": 0,
- "length": 0
}
], - "positive_delta": [
- "string"
], - "positive_count": [
- 0.1
], - "exemplars": [
- {
- "label": [
- null
], - "value": 0.1,
- "timestamp": "2019-08-24T14:15:22Z"
}
]
}, - "timestamp_ms": "string"
}
], - "unit": "string"
}
], - "execution_id": "string",
- "caller_prefix": "string"
}
}
ListTenants
Lists all tenants.
query Parameters
filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
action | string Action to be executed with a request. Not supported for all endpoints. |
mask | string List of fields to return (all fields are returned by default). |
traverse | boolean Get data from any child namespaces as well. |
sort.path | string Field to sort objects by, for example, meta.name. |
sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
ci_run_uuid | string Only return objects from PR scans that match this context id. |
page_id | string Page ID to retrieve. |
group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateTenant
Creates a tenant.
Request Body schema: application/jsonrequired
Tenant represents a tenant in the system.
Mostly includes tenant configuration parameters.
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1TenantSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
UpdateTenant
Updates a specified tenant.
Request Body schema: application/jsonrequired
Request to update a tenant.
object (v1UpdateRequest) Message used for all update requests. | |
object (v1Tenant) Tenant represents a tenant in the system. Mostly includes tenant configuration parameters. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
GetTenant
Fetches a tenant specified by its UUID.
path Parameters
uuid required | string The UUID of the requested resource. |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "code": "string",
- "phone_number": "string",
- "organizational_entity_name": "string",
- "organizational_contacts": [
- {
- "name": "string",
- "email": "string",
- "phone": "string"
}
], - "organization_urls": [
- "string"
]
}
}
UpdateToolPattern
Updates a tool pattern.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object ToolPattern represents the search pattern data for one tool. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
ListToolPatterns
Lists tool patterns.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateToolPattern
Creates a tool pattern.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Rules are associated with a tenant and namespace.) Rules are associated with a tenant and namespace. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1ToolPatternSpec) The internal specification of the object. |
propagate | boolean Indicates that the object should be visible in child namespaces. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
GetToolPattern
Fetches a tool pattern identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "categories": [
- "string"
], - "refs": [
- "string"
], - "file_patterns": [
- {
- "filename_patterns": [
- "string"
], - "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "cmd_patterns": [
- {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
], - "tool_patterns": {
- "property1": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}, - "property2": {
- "line_patterns": [
- "string"
], - "examples": [
- "string"
]
}
}, - "webhook_patterns": [
- "string"
], - "badge_patterns": [
- "string"
], - "display_name": "string",
- "app_patterns": [
- {
- "app_slug": "string"
}
]
}, - "propagate": true
}
DeleteToolPattern
Deletes a tool pattern specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
CreateUITelemetry
Creates a UI telemetry message.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace where the telemetry events were recorded.) Namespace where the telemetry events were recorded. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1UITelemetrySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "events": [
- {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
], - "device_user_agent": {
- "browser_name": "string",
- "browser_version": "string",
- "os_name": "string",
- "os_version": "string"
}, - "device_screen_info": {
- "width": 0,
- "height": 0,
- "available_width": 0,
- "available_height": 0
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "events": [
- {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
], - "device_user_agent": {
- "browser_name": "string",
- "browser_version": "string",
- "os_name": "string",
- "os_version": "string"
}, - "device_screen_info": {
- "width": 0,
- "height": 0,
- "available_width": 0,
- "available_height": 0
}
}
}
ListUsers
Lists all users.
query Parameters
filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
action | string Action to be executed with a request. Not supported for all endpoints. |
mask | string List of fields to return (all fields are returned by default). |
traverse | boolean Get data from any child namespaces as well. |
sort.path | string Field to sort objects by, for example, meta.name. |
sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
ci_run_uuid | string Only return objects from PR scans that match this context id. |
page_id | string Page ID to retrieve. |
group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateUser
Creates a user in a given namespace. Not exposed to public API.
Request Body schema: application/jsonrequired
User represents a user in the system.
Mostly includes configuration parameters that are user wise.
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1UserSpec) |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
UpdateUser
Updates a specific user. Not exposed to public API.
Request Body schema: application/jsonrequired
Request to update a user.
object (v1UpdateRequest) Message used for all update requests. | |
object (v1User) User represents a user in the system. Mostly includes configuration parameters that are user wise. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
GetUser
Fetches a user specified by their UUID
path Parameters
uuid required | string The UUID of the requested resource. |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}
Response samples
- 200
- default
{- "authentication_source": "string",
- "expiration_time": "2019-08-24T14:15:22Z",
- "user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}, - "tenants": [
- {
- "uuid": "string",
- "name": "string",
- "expiry": "2019-08-24T14:15:22Z",
- "license_type": "ENDOR_LICENSE_TYPE_UNSPECIFIED"
}
], - "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "namespaces": [
- "string"
]
}
GetActivePermissions
Returns user authentication data and allows a user to validate their token.
path Parameters
target_namespace required | string |
Responses
Response samples
- 200
- default
{- "authentication_source": "string",
- "expiration_time": "2019-08-24T14:15:22Z",
- "user": {
- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "last_login_time": "2019-08-24T14:15:22Z",
- "event_tracking": {
- "property1": {
- "event": [
- "string"
]
}, - "property2": {
- "event": [
- "string"
]
}
}, - "token_hash": "string"
}
}, - "tenants": [
- {
- "uuid": "string",
- "name": "string",
- "expiry": "2019-08-24T14:15:22Z",
- "license_type": "ENDOR_LICENSE_TYPE_UNSPECIFIED"
}
], - "permissions": {
- "rules": {
- "property1": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}, - "property2": {
- "methods": [
- "METHOD_UNSPECIFIED"
]
}
}, - "roles": [
- "SYSTEM_ROLE_UNSPECIFIED"
], - "except_resources": [
- "string"
]
}, - "namespaces": [
- "string"
]
}
UpdateUserTelemetry
Updates a given user telemetry.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object UserTelemetry represents user-specific events observered from the Endor Labs UI. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
ListUserTelemetries
Lists all user telemetry objects in a given namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateUserTelemetry
Creates a user telemetry message.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Namespace where the telemetry events were recorded.) Namespace where the telemetry events were recorded. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
required | object (v1UserTelemetrySpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
GetUserTelemetry
Fetches the user telemetry identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "user_id": "string",
- "session_id": "string",
- "event_store": {
- "property1": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}, - "property2": {
- "key": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "value": "string",
- "properties": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}
}
}
DeleteUserTelemetry
Deletes a user telemetry specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
UpdateVersionUpgrade
Updates a version upgrade.
path Parameters
object.tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1UpdateRequest) Message used for all update requests. | |
object VersionUpgrade contains all information about a possible version upgrade of a dependency package. This upgrade object can be under a project or a package version object. |
Responses
Request samples
- Payload
{- "request": {
- "update_mask": "string"
}, - "object": {
- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": null
}, - "meta": {
- "create_time": null,
- "update_time": null,
- "upsert_time": null,
- "name": null,
- "kind": null,
- "version": null,
- "description": null,
- "parent_uuid": null,
- "parent_kind": null,
- "tags": [ ],
- "annotations": { },
- "created_by": null,
- "updated_by": null,
- "references": { }
}, - "spec": {
- "project_uuid": null,
- "last_processed": null,
- "level": null,
- "dismiss": null,
- "remediation": null,
- "finding_metadata": null,
- "summary": null,
- "finding_tags": [ ],
- "target_uuid": null,
- "extra_key": null,
- "method": null,
- "target_dependency_package_name": null,
- "target_dependency_name": null,
- "target_dependency_version": null,
- "explanation": null,
- "remediation_action": null,
- "source_code_version": null,
- "reachable_paths": [ ],
- "ecosystem": null,
- "finding_categories": [ ],
- "relationship": null,
- "latest_version": null,
- "dependency_file_paths": [ ],
- "approximation": null,
- "proposed_version": null,
- "exceptions": null,
- "actions": null,
- "fixing_upgrades": null,
- "fixing_patch": null,
- "code_owners": null
}, - "context": {
- "type": null,
- "will_be_deleted_at": null,
- "id": null,
- "tags": [ ]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- null
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- null
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}, - "property2": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}, - "property2": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": null,
- "function_reference": null,
- "defined": null,
- "diff_change": null,
- "modifier_change": null
}, - "type_change": {
- "id": null,
- "declared_type": null,
- "package_name": null,
- "diff_change": null,
- "modifier_change": null
}, - "reachable_path": [
- null
], - "violating_types": {
- "property1": null,
- "property2": null
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- null
], - "conflicting_directs_upgrade": [
- null
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}, - "property2": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}, - "property2": {
- "current_count": null,
- "upgrade_count": null,
- "fixed": { },
- "introduced": { },
- "reduction": null,
- "fixed_summary": { },
- "introduced_summary": { },
- "fixed_count": null,
- "introduced_count": null,
- "reachable_fixed_count": null,
- "reachable_introduced_count": null
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": null,
- "function_reference": null,
- "defined": null,
- "diff_change": null,
- "modifier_change": null
}, - "type_change": {
- "id": null,
- "declared_type": null,
- "package_name": null,
- "diff_change": null,
- "modifier_change": null
}, - "reachable_path": [
- null
], - "violating_types": {
- "property1": null,
- "property2": null
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
ListVersionUpgrades
Lists all version upgrades in the namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}, - "property2": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}, - "property2": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": null,
- "property2": null
}, - "fixed_findings": [
- null
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": null,
- "property2": null
}, - "fixed_findings": [
- null
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": null,
- "type_change": null,
- "reachable_path": [ ],
- "violating_types": { },
- "confidence": null
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}, - "property2": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}, - "property2": {
- "current": null,
- "upgrade": null,
- "conflicting_current": null,
- "conflicting_upgrade": null,
- "conflicting_directs_current": [ ],
- "conflicting_directs_upgrade": [ ]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": null,
- "property2": null
}, - "fixed_findings": [
- null
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": null,
- "property2": null
}, - "fixed_findings": [
- null
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": null,
- "type_change": null,
- "reachable_path": [ ],
- "violating_types": { },
- "confidence": null
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": null,
- "property2": null
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": null,
- "property2": null
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": null,
- "property2": null
}, - "vuln_finding_info": {
- "reduction": null,
- "current_count": null,
- "upgrade_count": null,
- "severity": { },
- "fixed_findings": [ ]
}, - "other_finding_info": {
- "reduction": null,
- "current_count": null,
- "upgrade_count": null,
- "severity": { },
- "fixed_findings": [ ]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- null
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- null
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": null,
- "property2": null
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": null,
- "property2": null
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": null,
- "property2": null
}, - "vuln_finding_info": {
- "reduction": null,
- "current_count": null,
- "upgrade_count": null,
- "severity": { },
- "fixed_findings": [ ]
}, - "other_finding_info": {
- "reduction": null,
- "current_count": null,
- "upgrade_count": null,
- "severity": { },
- "fixed_findings": [ ]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- null
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- null
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateVersionUpgrade
Creates a version upgrade. The creation of the resource will be an upsert if the given spec.external_id and spec.platform_resource were already created.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object (Tenant metadata information.) Tenant metadata information. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1VersionUpgradeSpec) | |
required | object (v1Context) Contexts keep objects from different scans separated. |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "id": "string",
- "tags": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
GetVersionUpgrade
Fetches a version upgrade identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "project_uuid": "string",
- "upgrade_info": {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "introduced": {
- "property1": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}, - "property2": {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- null
], - "annotations": {
- "property1": null,
- "property2": null
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": null,
- "property2": null
}
}, - "spec": {
- "project_uuid": "string",
- "last_processed": "2019-08-24T14:15:22Z",
- "level": "FINDING_LEVEL_UNSPECIFIED",
- "dismiss": true,
- "remediation": "string",
- "finding_metadata": {
- "root_package_score_card": null,
- "dependency_score_card": null,
- "root_package_score_factor_list": null,
- "dependency_score_factor_list": null,
- "vulnerability": null,
- "root_package_resolved_dependencies": null,
- "source_policy_info": null,
- "ci_blocking_policy_info": null,
- "root_package_version_metadata": null,
- "dependency_package_version_metadata": null,
- "typosquatted_dependency_version_metadata": null,
- "container_data": null,
- "custom": null,
- "security_review_data": null
}, - "summary": "string",
- "finding_tags": [
- null
], - "target_uuid": "string",
- "extra_key": "string",
- "method": "SYSTEM_EVALUATION_METHOD_DEFINITION_UNSPECIFIED",
- "target_dependency_package_name": "string",
- "target_dependency_name": "string",
- "target_dependency_version": "string",
- "explanation": "string",
- "remediation_action": "FINDING_REMEDIATION_UNSPECIFIED",
- "source_code_version": {
- "sha": null,
- "ref": null,
- "metadata": { }
}, - "reachable_paths": [
- null
], - "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "finding_categories": [
- null
], - "relationship": "string",
- "latest_version": "string",
- "dependency_file_paths": [
- null
], - "approximation": true,
- "proposed_version": "string",
- "exceptions": {
- "policy_uuids": [ ],
- "tags": [ ]
}, - "actions": {
- "policy_uuids": [ ]
}, - "fixing_upgrades": {
- "upgrade_list": [ ]
}, - "fixing_patch": {
- "endor_patch_available": null
}, - "code_owners": {
- "owners": [ ],
- "labels": [ ]
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- null
]
}
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "introduced_summary": {
- "property1": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}, - "property2": {
- "uuid": "string",
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "finding_tags": [
- "FINDING_TAGS_UNSPECIFIED"
], - "level": "FINDING_LEVEL_UNSPECIFIED",
- "finding_categories": [
- "FINDING_CATEGORY_UNSPECIFIED"
], - "target_dependency_package_name": "string"
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- "string"
]
}, - "property2": {
- "values": [
- "string"
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}, - "name": "string",
- "configuration": {
- "upgrade_if_better_scores": true,
- "score_improvement_threshold": 0,
- "avoid_pre_releases": true,
- "prefer_minor_version_upgrades": true,
- "upgrade_if_operational_findings": "string",
- "upgrade_if_vulnerability_findings": "string",
- "no_upgrade_package_set": [
- "string"
], - "use_cia": true,
- "skip_test": true,
- "reachable_findings_only": true,
- "top_only": 0,
- "target_dependency": "string"
}, - "stats": {
- "namespace": "string",
- "project_uuid": "string",
- "project_name": "string",
- "package_count": 0,
- "package_manager_version_count": 0,
- "database_version_count": 0,
- "missing_version_count": 0,
- "dep_meta_count": 0,
- "direct_deps_package_count": 0,
- "direct_deps_count": 0,
- "dep_uuids": 0,
- "findings_read": 0,
- "findings_after_filtering": 0,
- "scores_read": 0,
- "data_load_time": 0.1,
- "compute_time": 0.1,
- "upgrades_reviewed": 0,
- "upgrades_skipped": 0,
- "upgrades_proposed": 0,
- "zero_conflict_upgrades_proposed": 0,
- "score_breakdown": {
- "property1": 0,
- "property2": 0
}, - "direct_dependency_count": 0,
- "incomplete_releases": 0,
- "pre_upgrade_findings_count": 0,
- "findings_fixed_by_upgrade_count": 0,
- "max_releases_behind": 0,
- "cia_invocations": 0,
- "skipped_due_to_cia": 0
}, - "prioritized_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "all_upgrades": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "introduced": {
- "property1": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}, - "property2": {
- "uuid": null,
- "tenant_meta": null,
- "meta": null,
- "spec": null,
- "context": null
}
}, - "reduction": 0,
- "fixed_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "introduced_summary": {
- "property1": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}, - "property2": {
- "uuid": null,
- "name": null,
- "description": null,
- "parent_uuid": null,
- "finding_tags": [ ],
- "level": null,
- "finding_categories": [ ],
- "target_dependency_package_name": null
}
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [
- null
]
}, - "property2": {
- "values": [
- null
]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "finding_fixing_upgrades": {
- "property1": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}, - "property2": {
- "upgrade_list": [
- {
- "project": "string",
- "root_package_version": "string",
- "root_pkg_version_uuid": "string",
- "direct_dependency_package": "string",
- "from_version": "string",
- "from_pkg_version_uuid": "string",
- "to_version": "string",
- "to_pkg_version_uuid": "string",
- "current_conflicts": 0,
- "conflicts": 0,
- "conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "minor_conflicts": 0,
- "minor_conflicts_map": {
- "property1": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}, - "property2": {
- "current": "string",
- "upgrade": "string",
- "conflicting_current": "string",
- "conflicting_upgrade": "string",
- "conflicting_directs_current": [
- "string"
], - "conflicting_directs_upgrade": [
- "string"
]
}
}, - "deps_added": 0,
- "deps_removed": 0,
- "cur_dep_count": 0,
- "update_dep_count": 0,
- "score": 0,
- "score_explanation": "string",
- "worth_it": true,
- "is_latest": true,
- "is_best": true,
- "endor_scores_improvement": {
- "property1": 0,
- "property2": 0
}, - "vuln_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "other_finding_info": {
- "reduction": 0,
- "current_count": 0,
- "upgrade_count": 0,
- "severity": {
- "property1": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}, - "property2": {
- "current_count": 0,
- "upgrade_count": 0,
- "fixed": {
- "property1": null,
- "property2": null
}, - "introduced": {
- "property1": null,
- "property2": null
}, - "reduction": 0,
- "fixed_summary": {
- "property1": null,
- "property2": null
}, - "introduced_summary": {
- "property1": null,
- "property2": null
}, - "fixed_count": 0,
- "introduced_count": 0,
- "reachable_fixed_count": 0,
- "reachable_introduced_count": 0
}
}, - "fixed_findings": [
- "string"
]
}, - "package_count": 0,
- "cia_status": "string",
- "from_version_age_in_days": 0,
- "to_version_age_in_days": 0,
- "cia_results": [
- {
- "function_change": {
- "id": "string",
- "function_reference": "string",
- "defined": true,
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "type_change": {
- "id": "string",
- "declared_type": "string",
- "package_name": "string",
- "diff_change": "CHANGE_TYPE_UNSPECIFIED",
- "modifier_change": "MODIFIER_CHANGE_TYPE_UNSPECIFIED"
}, - "reachable_path": [
- "string"
], - "violating_types": {
- "property1": {
- "values": [ ]
}, - "property2": {
- "values": [ ]
}
}, - "confidence": "CONFIDENCE_UNSPECIFIED"
}
], - "upgrade_risk": "string",
- "from_version_publish_time": "2019-08-24T14:15:22Z",
- "to_version_publish_time": "2019-08-24T14:15:22Z",
- "direct_dependency_manifest_files": [
- "string"
], - "total_findings_fixed": 0,
- "total_findings_introduced": 0,
- "is_endor_patch": true
}
]
}
}
}, - "context": {
- "type": "CONTEXT_TYPE_UNSPECIFIED",
- "will_be_deleted_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "tags": [
- "string"
]
}
}
DeleteVersionUpgrade
Deletes a version upgrade specified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the resource to be deleted. |
query Parameters
delete_parameters.action | string Action to be executed with delete request. |
Responses
Response samples
- 200
- default
{ }
VEXExportService_CreateVEXExport
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1Meta) Common fields for all Endor Labs resources. | |
tenant_meta | object (SBOM are associated with a tenant and tenant information must be provided.) SBOM are associated with a tenant and tenant information must be provided. |
object (v1ExportedVEXSpec) The internal specification of the object. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "format": "FORMAT_UNSPECIFIED",
- "component_type": "COMPONENT_TYPE_UNSPECIFIED",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "export_parameters": {
- "project_uuid": "string",
- "project_name": "string",
- "package_version_uuids": [
- { }
], - "repository_version": "string"
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "data": "string",
- "format": "FORMAT_UNSPECIFIED",
- "component_type": "COMPONENT_TYPE_UNSPECIFIED",
- "kind": "SBOM_KIND_UNSPECIFIED",
- "export_parameters": {
- "project_uuid": "string",
- "project_name": "string",
- "package_version_uuids": [
- { }
], - "repository_version": "string"
}
}
}
ListVulnerabilities
List all vulnerabilities in the namespace.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
query Parameters
list_parameters.filter | string String of conditions to filter resources by. Filters may include any attribute along with the following operators: "==", "!=", ">", ">=", "<", "<=", "Contains", "In", "Matches", and "Exists". The logical operators "And" and "Or" are also supported. Expressions may be combined and grouped with parentheses. Examples: "spec.value == 5", "spec.value in ["a", "b", "c"]", "(meta.name == "xyz" and "spec.value in ["a","b"]) or (spec.value == "c")". |
list_parameters.page_token | integer <int32> Set the page token to start from. Use page tokens to page through list results or list specific pages. |
list_parameters.page_size | integer <int32> Set the page size to limit the number of results returned. Default: 100. Max: 500. |
list_parameters.action | string Action to be executed with a request. Not supported for all endpoints. |
list_parameters.mask | string List of fields to return (all fields are returned by default). |
list_parameters.traverse | boolean Get data from any child namespaces as well. |
list_parameters.sort.path | string Field to sort objects by, for example, meta.name. |
list_parameters.sort.order | string Default: "SORT_ENTRY_ORDER_UNSPECIFIED" Enum: "SORT_ENTRY_ORDER_UNSPECIFIED" "SORT_ENTRY_ORDER_ASC" "SORT_ENTRY_ORDER_DESC" Sort order. Default: ASC. |
list_parameters.count | boolean Return the number of objects matching the given list parameters. If count is set to true, the response is a CountResponse. Can be used together with filter and traverse. |
list_parameters.group.aggregation_paths | string Group the objects based on this field. If there are multiple fields then the objects are grouped based on the uniqueness of all fields. Supports composite paths. Supports arrays and maps. |
list_parameters.group.show_aggregation_uuids | boolean Return the UUID of each object in each group as specified by aggregation_paths. |
list_parameters.group.unique_count_paths | string List of fields for which we want the unique count. Supports arrays and maps. |
list_parameters.group.unique_value_paths | string List of fields for which we want the unique values. Supports arrays and maps. |
list_parameters.ci_run_uuid | string Only return objects from PR scans that match this context id. |
list_parameters.page_id | string Page ID to retrieve. |
list_parameters.group_by_time.aggregation_paths | string Group the objects based on this time field, for example, meta.create_time. |
list_parameters.group_by_time.show_aggregation_uuids | boolean Return the UUIDs of the objects in each group. |
list_parameters.group_by_time.interval | string Default: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" Enum: "GROUP_BY_TIME_INTERVAL_UNSPECIFIED" "GROUP_BY_TIME_INTERVAL_YEAR" "GROUP_BY_TIME_INTERVAL_QUARTER" "GROUP_BY_TIME_INTERVAL_MONTH" "GROUP_BY_TIME_INTERVAL_WEEK" "GROUP_BY_TIME_INTERVAL_DAY" "GROUP_BY_TIME_INTERVAL_HOUR" "GROUP_BY_TIME_INTERVAL_MINUTE" "GROUP_BY_TIME_INTERVAL_SECOND" Interval unit by which the objects should be grouped. |
list_parameters.group_by_time.group_size | integer <int32> Size of the time interval to group the objects by, for example, to group objects by 2-week intervals, set interval to GROUP_BY_TIME_INTERVAL_WEEK and group_size to 2. |
list_parameters.group_by_time.start_time | string <date-time> Beginning of the time period to group objects. Defaults to the beginning of time. |
list_parameters.group_by_time.end_time | string <date-time> End of the time period to group objects. Defaults to the current time. |
list_parameters.group_by_time.mode | string The mode determines how the matching objects are counted in the produced time-series. Values allowed are: count (default) : is the number of items matching in every interval. sum: is the total number of items matching since the beginning of the aggregation time. |
list_parameters.group_by_time.aggregation_value_field | string The aggregation_field is a field on the matched objects that we want to perform some operation in each interval (example : min, max, avg) |
list_parameters.group_by_time.aggregation_operator | string The aggreation_operator is the operator that we should use for the aggregation. Allowed values are: min, max, sum, avg |
Responses
Response samples
- 200
- default
{- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": null,
- "ecosystem": null,
- "purl": null
}, - "ranges": [
- null
], - "versions": [
- null
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- null
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- null
], - "fixed_versions": [
- null
], - "vulnerable_filepath": [
- null
], - "versions_range": [
- null
], - "endor_uri": [
- null
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": null,
- "value": null
}
], - "references": [
- {
- "url": null,
- "source": null,
- "tags": [ ]
}
], - "metrics": {
- "cvss_metric_v2": [
- null
], - "cvss_metric_v30": [
- null
], - "cvss_metric_v31": [
- null
]
}, - "weaknesses": [
- {
- "source": null,
- "type": null,
- "description": [ ]
}
], - "configurations": [
- {
- "operator": null,
- "negate": null,
- "nodes": [ ]
}
], - "vendor_comments": [
- {
- "organization": null,
- "comment": null,
- "last_modified": null
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
CreateVulnerability
Creates a vulnerability based on the ID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
tenant_meta | object Tenant related data for the tenant containing the resource. |
required | object (v1Meta) Common fields for all Endor Labs resources. |
object (v1VulnSpec) |
Responses
Request samples
- Payload
{- "tenant_meta": { },
- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "ranges": [
- {
- "type": "UNSPECIFIED",
- "repo": "string",
- "events": [
- {
- "introduced": null,
- "fixed": null,
- "limit": null
}
]
}
], - "versions": [
- "string"
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- "string"
], - "fixed_versions": [
- "string"
], - "vulnerable_filepath": [
- "string"
], - "versions_range": [
- "string"
], - "endor_uri": [
- "string"
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": "string",
- "value": "string"
}
], - "references": [
- {
- "url": "string",
- "source": "string",
- "tags": [
- "string"
]
}
], - "metrics": {
- "cvss_metric_v2": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "access_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "access_complexity": "ACCESS_COMPLEXITY_UNSPECIFIED",
- "authentication": "AUTH_UNSPECIFIED",
- "confidentiality_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "integrity_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "availability_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "exploitability": "EXPLOITABILITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "collateral_damage_potential": "COLLATERAL_DAMAGE_POTENTIAL_UNSPECIFIED",
- "target_distribution": "TARGET_DISTRIBUTION_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "environmental_score": 0.1
}, - "base_severity": "string",
- "exploitability_score": 0.1,
- "impact_score": 0.1,
- "ac_insuf_info": true,
- "obtain_all_privilege": true,
- "obtain_user_privilege": true,
- "obtain_other_privilege": true,
- "user_interaction_required": true
}
], - "cvss_metric_v30": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
], - "cvss_metric_v31": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
]
}, - "weaknesses": [
- {
- "source": "string",
- "type": "string",
- "description": [
- {
- "lang": "string",
- "value": "string"
}
]
}
], - "configurations": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "nodes": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "cpe_match": [
- null
]
}
]
}
], - "vendor_comments": [
- {
- "organization": "string",
- "comment": "string",
- "last_modified": "2019-08-24T14:15:22Z"
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "ranges": [
- {
- "type": "UNSPECIFIED",
- "repo": "string",
- "events": [
- {
- "introduced": null,
- "fixed": null,
- "limit": null
}
]
}
], - "versions": [
- "string"
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- "string"
], - "fixed_versions": [
- "string"
], - "vulnerable_filepath": [
- "string"
], - "versions_range": [
- "string"
], - "endor_uri": [
- "string"
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": "string",
- "value": "string"
}
], - "references": [
- {
- "url": "string",
- "source": "string",
- "tags": [
- "string"
]
}
], - "metrics": {
- "cvss_metric_v2": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "access_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "access_complexity": "ACCESS_COMPLEXITY_UNSPECIFIED",
- "authentication": "AUTH_UNSPECIFIED",
- "confidentiality_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "integrity_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "availability_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "exploitability": "EXPLOITABILITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "collateral_damage_potential": "COLLATERAL_DAMAGE_POTENTIAL_UNSPECIFIED",
- "target_distribution": "TARGET_DISTRIBUTION_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "environmental_score": 0.1
}, - "base_severity": "string",
- "exploitability_score": 0.1,
- "impact_score": 0.1,
- "ac_insuf_info": true,
- "obtain_all_privilege": true,
- "obtain_user_privilege": true,
- "obtain_other_privilege": true,
- "user_interaction_required": true
}
], - "cvss_metric_v30": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
], - "cvss_metric_v31": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
]
}, - "weaknesses": [
- {
- "source": "string",
- "type": "string",
- "description": [
- {
- "lang": "string",
- "value": "string"
}
]
}
], - "configurations": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "nodes": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "cpe_match": [
- null
]
}
]
}
], - "vendor_comments": [
- {
- "organization": "string",
- "comment": "string",
- "last_modified": "2019-08-24T14:15:22Z"
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
GetVulnerability
Fetches a vulnerability identified by the UUID.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
uuid required | string The UUID of the requested resource. |
query Parameters
get_parameters.mask | string List of fields to return (all fields are returned by default). |
Responses
Response samples
- 200
- default
{- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- "string"
]
}, - "ranges": [
- {
- "type": "RANGE_TYPE_UNSPECIFIED",
- "introduced": "string",
- "fixed": "string",
- "repo": "string"
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "ranges": [
- {
- "type": "UNSPECIFIED",
- "repo": "string",
- "events": [
- {
- "introduced": null,
- "fixed": null,
- "limit": null
}
]
}
], - "versions": [
- "string"
], - "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": "NONE",
- "url": "string"
}
], - "database_specific": { },
- "severity": [
- {
- "type": "UNSPECIFIED",
- "score": "string"
}
], - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": "string",
- "artifact_id": "string",
- "vulnerable_versions": [
- "string"
], - "fixed_versions": [
- "string"
], - "vulnerable_filepath": [
- "string"
], - "versions_range": [
- "string"
], - "endor_uri": [
- "string"
]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- {
- "lang": "string",
- "value": "string"
}
], - "references": [
- {
- "url": "string",
- "source": "string",
- "tags": [
- "string"
]
}
], - "metrics": {
- "cvss_metric_v2": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "access_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "access_complexity": "ACCESS_COMPLEXITY_UNSPECIFIED",
- "authentication": "AUTH_UNSPECIFIED",
- "confidentiality_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "integrity_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "availability_impact": "V2_IMPACT_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "exploitability": "EXPLOITABILITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "collateral_damage_potential": "COLLATERAL_DAMAGE_POTENTIAL_UNSPECIFIED",
- "target_distribution": "TARGET_DISTRIBUTION_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "environmental_score": 0.1
}, - "base_severity": "string",
- "exploitability_score": 0.1,
- "impact_score": 0.1,
- "ac_insuf_info": true,
- "obtain_all_privilege": true,
- "obtain_user_privilege": true,
- "obtain_other_privilege": true,
- "user_interaction_required": true
}
], - "cvss_metric_v30": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
], - "cvss_metric_v31": [
- {
- "source": "string",
- "type": "NVD_METRIC_TYPE_UNSPECIFIED",
- "cvss_data": {
- "version": "string",
- "vector_string": "string",
- "attack_vector": "NVD_ATTACK_VECTOR_UNSPECIFIED",
- "attack_complexity": "NVD_ATTACK_COMPLEXITY_UNSPECIFIED",
- "privileges_required": "NVD_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "user_interaction": "NVD_USER_INTERACTION_UNSPECIFIED",
- "scope": "NVD_SCOPE_UNSPECIFIED",
- "confidentiality_impact": "NVD_IMPACT_UNSPECIFIED",
- "integrity_impact": "NVD_IMPACT_UNSPECIFIED",
- "availability_impact": "NVD_IMPACT_UNSPECIFIED",
- "base_score": 0.1,
- "base_severity": "NVD_SEVERITY_UNSPECIFIED",
- "exploit_code_maturity": "NVD_EXPLOIT_CODE_MATURITY_UNSPECIFIED",
- "remediation_level": "NVD_REMEDIATION_LEVEL_UNSPECIFIED",
- "report_confidence": "NVD_REPORT_CONFIDENCE_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_severity": "NVD_SEVERITY_UNSPECIFIED",
- "confidentiality_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "integrity_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "availability_requirement": "NVD_REQUIREMENT_UNSPECIFIED",
- "modified_attack_vector": "NVD_MODIFIED_ATTACK_VECTOR_UNSPECIFIED",
- "modified_attack_complexity": "NVD_MODIFIED_ATTACK_COMPLEXITY_UNSPECIFIED",
- "modified_privileges_required": "NVD_MODIFIED_PRIVILEGES_REQUIRED_UNSPECIFIED",
- "modified_user_interaction": "NVD_MODIFIED_USER_INTERACTION_UNSPECIFIED",
- "modified_scope": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_confidentiality_impact": "NVD_MODIFIED_SCOPE_UNSPECIFIED",
- "modified_integrity_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "modified_availability_impact": "NVD_MODIFIED_IMPACT_UNSPECIFIED",
- "environmental_score": 0.1,
- "environmental_severity": "NVD_SEVERITY_UNSPECIFIED"
}, - "exploitability_score": 0.1,
- "impact_score": 0.1
}
]
}, - "weaknesses": [
- {
- "source": "string",
- "type": "string",
- "description": [
- {
- "lang": "string",
- "value": "string"
}
]
}
], - "configurations": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "nodes": [
- {
- "operator": "OPERATOR_UNSPECIFIED",
- "negate": true,
- "cpe_match": [
- null
]
}
]
}
], - "vendor_comments": [
- {
- "organization": "string",
- "comment": "string",
- "last_modified": "2019-08-24T14:15:22Z"
}
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
CreateQueryVulnerability
Queries vulnerabilities for specific values. Use this method to query vulnerabilities for a specific package version.
path Parameters
tenant_meta.namespace required | string Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". |
Request Body schema: application/jsonrequired
object (v1Meta) Common fields for all Endor Labs resources. | |
tenant_meta | object Tenant related data for the tenant containing the resource. |
object (v1QueryVulnerabilitySpec) | |
object (QueryVulnerabilityResponseMap) | |
object (v1ListVulnerabilitiesResponse) Response to the request to list vulnerabilities. |
Responses
Request samples
- Payload
{- "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "tenant_meta": { },
- "spec": {
- "package_version_name": "string",
- "package_version_names": {
- "names": [
- "string"
]
}, - "purls": [
- "string"
], - "mask": "string",
- "vulnerability_type": "VULNERABILITY_TYPE_UNSPECIFIED"
}, - "responses": {
- "values": {
- "property1": {
- "list": {
- "objects": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}, - "property2": {
- "list": {
- "objects": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
}
}, - "response": {
- "list": {
- "objects": [
- {
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "name": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- null
]
}, - "ranges": [
- {
- "type": null,
- "introduced": null,
- "fixed": null,
- "repo": null
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "database_specific": { },
- "severity": [
- {
- "type": null,
- "score": null
}
], - "credits": [
- {
- "name": null,
- "contact": [ ]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": null,
- "artifact_id": null,
- "vulnerable_versions": [ ],
- "fixed_versions": [ ],
- "vulnerable_filepath": [ ],
- "versions_range": [ ],
- "endor_uri": [ ]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- null
], - "references": [
- null
], - "metrics": {
- "cvss_metric_v2": [ ],
- "cvss_metric_v30": [ ],
- "cvss_metric_v31": [ ]
}, - "weaknesses": [
- null
], - "configurations": [
- null
], - "vendor_comments": [
- null
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
}
Response samples
- 200
- default
{- "uuid": "string",
- "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "tenant_meta": {
- "namespace": "string"
}, - "spec": {
- "package_version_name": "string",
- "package_version_names": {
- "names": [
- "string"
]
}, - "purls": [
- "string"
], - "mask": "string",
- "vulnerability_type": "VULNERABILITY_TYPE_UNSPECIFIED"
}, - "responses": {
- "values": {
- "property1": {
- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}, - "property2": {
- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": null,
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": null,
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": null,
- "contact": [ ]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [ ],
- "affected_callpath_uris": [ ],
- "fix_commits": [ ],
- "has_been_fixed": null,
- "source": null,
- "maintainer_severity": null
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": null,
- "id": null,
- "published": null,
- "modified": null,
- "withdrawn": null,
- "aliases": [ ],
- "related": [ ],
- "package": null,
- "summary": null,
- "details": null,
- "affected": [ ],
- "references": [ ],
- "database_specific": { },
- "severity": [ ],
- "credits": [ ]
}, - "endor_vulnerability": {
- "cve_id": null,
- "cve_description": null,
- "cvss_score": null,
- "cvss_vector": null,
- "cwe": null,
- "cve_references": [ ],
- "package_name": null,
- "ecosystem": null,
- "fix_commit": [ ],
- "additional_notes": null,
- "component": [ ],
- "deepdive": null,
- "disputed": null,
- "nofix": null,
- "schema_version": null,
- "malicious": null,
- "withdrawn": null
}, - "epss_record": {
- "cve_id": null,
- "probability": null,
- "percentile": null,
- "ingestion_time": null
}, - "nvd_vulnerability": {
- "cve": null
}, - "kev_record": {
- "cve_id": null,
- "vendor_project": null,
- "product": null,
- "vulnerability_name": null,
- "date_added": null,
- "short_description": null,
- "required_action": null,
- "due_date": null,
- "known_ransomware_campaign_use": null,
- "notes": null
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
}
}, - "response": {
- "list": {
- "objects": [
- {
- "uuid": "string",
- "tenant_meta": {
- "namespace": "string"
}, - "meta": {
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "upsert_time": "2019-08-24T14:15:22Z",
- "name": "string",
- "kind": "string",
- "version": "string",
- "description": "string",
- "parent_uuid": "string",
- "parent_kind": "string",
- "tags": [
- "string"
], - "annotations": {
- "property1": "string",
- "property2": "string"
}, - "created_by": "string",
- "updated_by": "string",
- "references": {
- "property1": {
- "@type": "string",
- "property1": null,
- "property2": null
}, - "property2": {
- "@type": "string",
- "property1": null,
- "property2": null
}
}
}, - "spec": {
- "deepdive": true,
- "disputed": true,
- "additional_notes": [
- "string"
], - "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "cvss_v3_severity": {
- "score": 0.1,
- "vector": "string",
- "level": "LEVEL_UNSPECIFIED",
- "temporal_score": 0.1,
- "temporal_vector": "string",
- "temporal_level": "LEVEL_UNSPECIFIED"
}, - "credits": [
- {
- "name": "string",
- "contact": [
- "string"
]
}
], - "database_specific": { },
- "summary": "string",
- "affected": [
- {
- "package": {
- "name": "string",
- "ecosystem": "ECOSYSTEM_UNSPECIFIED",
- "purl": "string",
- "cpe": "string",
- "cpes": [
- null
]
}, - "ranges": [
- {
- "type": null,
- "introduced": null,
- "fixed": null,
- "repo": null
}
], - "versions": [
- "string"
], - "database_specific": { },
- "ecosystem_specific": { },
- "affected_filepaths": [
- "string"
], - "affected_callpath_uris": [
- "string"
], - "fix_commits": [
- "string"
], - "has_been_fixed": true,
- "source": "SOURCE_UNSPECIFIED",
- "maintainer_severity": "LEVEL_UNSPECIFIED"
}
], - "references": [
- {
- "type": "REFERENCE_TYPE_UNSPECIFIED",
- "url": "string"
}
], - "epss_score": {
- "probability_score": 0.1,
- "percentile_score": 0.1
}, - "raw": {
- "osv_vulnerability": {
- "schema_version": "string",
- "id": "string",
- "published": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "withdrawn": "2019-08-24T14:15:22Z",
- "aliases": [
- "string"
], - "related": [
- "string"
], - "package": {
- "name": "string",
- "ecosystem": "string",
- "purl": "string"
}, - "summary": "string",
- "details": "string",
- "affected": [
- {
- "package": null,
- "ranges": [ ],
- "versions": [ ],
- "ecosystem_specific": { },
- "database_specific": { }
}
], - "references": [
- {
- "type": null,
- "url": null
}
], - "database_specific": { },
- "severity": [
- {
- "type": null,
- "score": null
}
], - "credits": [
- {
- "name": null,
- "contact": [ ]
}
]
}, - "endor_vulnerability": {
- "cve_id": "string",
- "cve_description": "string",
- "cvss_score": 0.1,
- "cvss_vector": "string",
- "cwe": "string",
- "cve_references": [
- "string"
], - "package_name": "string",
- "ecosystem": "string",
- "fix_commit": [
- "string"
], - "additional_notes": "string",
- "component": [
- {
- "group_id": null,
- "artifact_id": null,
- "vulnerable_versions": [ ],
- "fixed_versions": [ ],
- "vulnerable_filepath": [ ],
- "versions_range": [ ],
- "endor_uri": [ ]
}
], - "deepdive": true,
- "disputed": true,
- "nofix": true,
- "schema_version": "string",
- "malicious": true,
- "withdrawn": "2019-08-24T14:15:22Z"
}, - "epss_record": {
- "cve_id": "string",
- "probability": 0.1,
- "percentile": 0.1,
- "ingestion_time": "2019-08-24T14:15:22Z"
}, - "nvd_vulnerability": {
- "cve": {
- "id": "string",
- "source_identifier": "string",
- "vuln_status": "string",
- "vuln_typed_status": "NVD_STATUS_UNSPECIFIED",
- "published": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "evaluator_comment": "string",
- "evaluator_solution": "string",
- "evaluator_impact": "string",
- "cisa_exploit_add": "string",
- "cisa_action_due": "string",
- "cisa_required_action": "string",
- "cisa_vulnerability_name": "string",
- "descriptions": [
- null
], - "references": [
- null
], - "metrics": {
- "cvss_metric_v2": [ ],
- "cvss_metric_v30": [ ],
- "cvss_metric_v31": [ ]
}, - "weaknesses": [
- null
], - "configurations": [
- null
], - "vendor_comments": [
- null
]
}
}, - "kev_record": {
- "cve_id": "string",
- "vendor_project": "string",
- "product": "string",
- "vulnerability_name": "string",
- "date_added": "2019-08-24T14:15:22Z",
- "short_description": "string",
- "required_action": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "known_ransomware_campaign_use": "string",
- "notes": "string"
}
}, - "malicious": true,
- "additional_endor_notes": [
- "string"
]
}
}
], - "response": {
- "next_page_token": 0,
- "next_page_id": "string"
}
}, - "count_response": {
- "count": 0
}, - "group_response": {
- "groups": {
- "property1": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}, - "property2": {
- "aggregation_count": {
- "count": 0
}, - "aggregation_uuids": [
- "string"
], - "unique_counts": {
- "property1": {
- "count": 0
}, - "property2": {
- "count": 0
}
}, - "unique_values": {
- "property1": [
- { }
], - "property2": [
- { }
]
}, - "aggregation_value": {
- "value": 0.1
}
}
}
}
}
}