{"components":{"schemas":{"ListQuery":{"description":"Search, filter, paginate, and order a resource collection.","properties":{"descending":{"description":"Sorts in descending order when true.","type":"boolean"},"filters":{"description":"Filters combined with AND at the top level.","items":{"description":"Filters combined with AND at the top level.","properties":{"field":{"description":"Public field; required for comparisons and omitted for AND and OR.","type":"string"},"not":{"description":"Negates the filter.","type":"boolean"},"operator":{"description":"Case-sensitive comparison or logical operator.","enum":["=","\u003c","\u003c=","\u003e","\u003e=","STARTS WITH","ENDS WITH","IN","IS NOT NULL","AND","OR"],"type":"string"},"value":{"description":"Comparison value; use an array for IN, omit for IS NOT NULL, and provide child filters for AND and OR."}},"required":["operator"],"type":"object"},"type":"array"},"limit":{"description":"Items per page; defaults to 100 and is capped at 1000.","type":"integer"},"orderBy":{"description":"Public field used to order results.","type":"string"},"page":{"description":"One-based page number; defaults to 1.","type":"integer"},"search":{"description":"Full-text search phrase.","type":"string"}},"type":"object"}},"securitySchemes":{"account":{"description":"Set the `Account` header to the Guard account username on every API request.","in":"header","name":"Account","type":"apiKey"},"oauth2":{"description":"Use the Guard API Key ID as `client_id` and API Key Secret as `client_secret`. Exchange them at `/token` for a JWT, then send `Authorization: Bearer \u003ctoken\u003e` with every API request.","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/token"}},"type":"oauth2"}}},"info":{"contact":{"email":"support@praetorian.com","name":"Praetorian Support"},"description":"The Guard Customer API is a stable, versioned interface for managing assets, vulnerabilities, seeds, technologies, and exports. All endpoints are under `/api/v1` and return JSON.\n\nEvery API request requires both an `Authorization: Bearer \u003ctoken\u003e` header and an `Account: \u003cusername\u003e` header.\n\nFor help or to request another endpoint, contact [support@praetorian.com](mailto:support@praetorian.com).","title":"Guard Customer API","version":"1.0.0"},"openapi":"3.0.3","paths":{"/api/v1/assets":{"get":{"description":"Returns assets matching the supplied full-text search and filters.","operationId":"listAssets","parameters":[{"content":{"application/json":{"example":{"descending":true,"filters":[{"operator":"OR","value":[{"field":"status","operator":"=","value":"A"},{"field":"source","operator":"STARTS WITH","value":"AWS"}]}],"limit":50,"orderBy":"updated","page":1,"search":"internet-facing"},"schema":{"$ref":"#/components/schemas/ListQuery"}}},"description":"Search, filter, paginate, and order assets. Allowed filter and order fields: `created`, `group`, `identifier`, `key`, `source`, `status`, `tags`, `updated`.","in":"query","name":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"description":"Resources in this page.","items":{"description":"Resources in this page.","properties":{"created":{"description":"Creation timestamp.","type":"string"},"group":{"description":"Asset group: CIDR, registrable domain or TLD, FQDN, or parent DNS name for name-based identifiers.","type":"string"},"identifier":{"description":"Asset identifier: IPv4 or IPv6 address, CIDR, TLD, or DNS name.","type":"string"},"key":{"description":"Canonical #asset#{group}#{identifier} key; supported classes are ipv4, ipv6, cidr, tld, and domain.","type":"string"},"source":{"description":"System that discovered the asset.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, F frozen, D deleted, or FR frozen-rejected.","enum":["A","P","F","D","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"updated":{"description":"Last observation timestamp.","type":"string"}},"required":["created","group","identifier","key","source","status","updated"],"type":"object"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"List assets"},"patch":{"description":"Updates the supplied fields. Comment appends a new history note and preserves existing notes.","operationId":"patchAsset","requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"description":"New history note; existing notes are preserved.","nullable":true,"type":"string"},"key":{"description":"Canonical #asset#{group}#{identifier} key.","nullable":true,"type":"string"},"status":{"description":"Lifecycle status: A active, P pending, F frozen, D deleted, or FR frozen-rejected.","enum":["A","P","F","D","FR"],"nullable":true,"type":"string"},"tags":{"description":"Replacement customer-defined labels.","items":{"description":"Replacement customer-defined labels.","type":"string"},"nullable":true,"type":"array"}},"required":["key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"group":{"description":"Asset group: CIDR, registrable domain or TLD, FQDN, or parent DNS name for name-based identifiers.","type":"string"},"identifier":{"description":"Asset identifier: IPv4 or IPv6 address, CIDR, TLD, or DNS name.","type":"string"},"key":{"description":"Canonical #asset#{group}#{identifier} key; supported classes are ipv4, ipv6, cidr, tld, and domain.","type":"string"},"source":{"description":"System that discovered the asset.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, F frozen, D deleted, or FR frozen-rejected.","enum":["A","P","F","D","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"updated":{"description":"Last observation timestamp.","type":"string"}},"required":["created","group","identifier","key","source","status","updated"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Update an asset"},"put":{"description":"Creates an asset or replaces its customer-managed fields. Comment records an initial or additional history note.","operationId":"putAsset","requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"description":"Initial or additional history note.","type":"string"},"group":{"description":"Asset group: CIDR, registrable domain or TLD, FQDN, or parent DNS name for name-based identifiers.","type":"string"},"identifier":{"description":"Asset identifier: IPv4 or IPv6 address, CIDR, TLD, or DNS name.","type":"string"},"key":{"description":"Canonical #asset#{group}#{identifier} key; supported classes are ipv4, ipv6, cidr, tld, and domain.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, F frozen, D deleted, or FR frozen-rejected.","enum":["A","P","F","D","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"}},"required":["group","identifier","key","status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"group":{"description":"Asset group: CIDR, registrable domain or TLD, FQDN, or parent DNS name for name-based identifiers.","type":"string"},"identifier":{"description":"Asset identifier: IPv4 or IPv6 address, CIDR, TLD, or DNS name.","type":"string"},"key":{"description":"Canonical #asset#{group}#{identifier} key; supported classes are ipv4, ipv6, cidr, tld, and domain.","type":"string"},"source":{"description":"System that discovered the asset.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, F frozen, D deleted, or FR frozen-rejected.","enum":["A","P","F","D","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"updated":{"description":"Last observation timestamp.","type":"string"}},"required":["created","group","identifier","key","source","status","updated"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Create or replace an asset"}},"/api/v1/exports":{"post":{"description":"Queues a constrained export of one supported resource type.","operationId":"postExport","requestBody":{"content":{"application/json":{"schema":{"properties":{"entity_type":{"description":"Resource type included in the export.","enum":["assets","vulnerabilities","seeds","technologies"],"type":"string"},"filters":{"description":"Constrained resource filters.","items":{"description":"Constrained resource filters.","properties":{"field":{"description":"Public field; required for comparisons and omitted for AND and OR.","type":"string"},"not":{"description":"Negates the filter.","type":"boolean"},"operator":{"description":"Case-sensitive comparison or logical operator.","enum":["=","\u003c","\u003c=","\u003e","\u003e=","STARTS WITH","ENDS WITH","IN","IS NOT NULL","AND","OR"],"type":"string"},"value":{"description":"Comparison value; use an array for IN, omit for IS NOT NULL, and provide child filters for AND and OR."}},"required":["operator"],"type":"object"},"type":"array"},"format":{"description":"Export file format.","enum":["csv","json","pdf"],"type":"string"},"search":{"description":"Full-text search phrase.","type":"string"}},"required":["entity_type","format"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"download_url":{"description":"Temporary download URL for a completed export.","type":"string"},"finished":{"description":"Completion timestamp.","type":"string"},"id":{"description":"Export job identifier.","type":"string"},"started":{"description":"Start timestamp.","type":"string"},"status":{"description":"Current export state.","enum":["queued","running","pass","fail","unknown"],"type":"string"}},"required":["created","id","status"],"type":"object"}}},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Create an export"}},"/api/v1/exports/{id}":{"get":{"description":"Returns an export job and its download URL when complete.","operationId":"getExport","parameters":[{"description":"Export job identifier.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"download_url":{"description":"Temporary download URL for a completed export.","type":"string"},"finished":{"description":"Completion timestamp.","type":"string"},"id":{"description":"Export job identifier.","type":"string"},"started":{"description":"Start timestamp.","type":"string"},"status":{"description":"Current export state.","enum":["queued","running","pass","fail","unknown"],"type":"string"}},"required":["created","id","status"],"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Get export status"}},"/api/v1/seeds":{"get":{"description":"Returns seeds matching the supplied full-text search and filters.","operationId":"listSeeds","parameters":[{"content":{"application/json":{"example":{"filters":[{"field":"status","operator":"IN","value":["A","P"]}],"limit":25,"orderBy":"created","page":1},"schema":{"$ref":"#/components/schemas/ListQuery"}}},"description":"Search, filter, paginate, and order seeds. Allowed filter and order fields: `created`, `dns`, `key`, `name`, `source`, `status`, `tags`, `updated`.","in":"query","name":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"description":"Resources in this page.","items":{"description":"Resources in this page.","properties":{"dns":{"description":"Seed group: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"key":{"description":"Canonical #asset#{dns}#{name} key; supported classes are domain, tld, and ipv4.","type":"string"},"name":{"description":"Seed identifier: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, or FR frozen-rejected.","enum":["A","P","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"}},"required":["dns","key","name","status"],"type":"object"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"List seeds"},"patch":{"description":"Updates the supplied fields. Comment appends a new history note and preserves existing notes.","operationId":"patchSeed","requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"description":"New history note; existing notes are preserved.","nullable":true,"type":"string"},"key":{"description":"Canonical #asset#{dns}#{name} key.","nullable":true,"type":"string"},"status":{"description":"Lifecycle status: A active, P pending, or FR frozen-rejected.","enum":["A","P","FR"],"nullable":true,"type":"string"},"tags":{"description":"Replacement customer-defined labels.","items":{"description":"Replacement customer-defined labels.","type":"string"},"nullable":true,"type":"array"}},"required":["key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dns":{"description":"Seed group: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"key":{"description":"Canonical #asset#{dns}#{name} key; supported classes are domain, tld, and ipv4.","type":"string"},"name":{"description":"Seed identifier: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, or FR frozen-rejected.","enum":["A","P","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"}},"required":["dns","key","name","status"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Update a seed"},"put":{"description":"Creates a seed or replaces its customer-managed fields. Comment records an initial or additional history note.","operationId":"putSeed","requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"description":"Initial or additional history note.","type":"string"},"dns":{"description":"Seed group: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"key":{"description":"Canonical #asset#{dns}#{name} key; supported classes are domain, tld, and ipv4.","type":"string"},"name":{"description":"Seed identifier: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, or FR frozen-rejected; omitted defaults to pending.","enum":["A","P","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"}},"required":["dns","key","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dns":{"description":"Seed group: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"key":{"description":"Canonical #asset#{dns}#{name} key; supported classes are domain, tld, and ipv4.","type":"string"},"name":{"description":"Seed identifier: FQDN, registrable domain or TLD, or IPv4 address.","type":"string"},"status":{"description":"Lifecycle status: A active, P pending, or FR frozen-rejected.","enum":["A","P","FR"],"type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"}},"required":["dns","key","name","status"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Create or replace a seed"}},"/api/v1/technologies":{"get":{"description":"Returns technologies matching the supplied full-text search and filters.","operationId":"listTechnologies","parameters":[{"content":{"application/json":{"example":{"filters":[{"field":"vendor","operator":"=","value":"Microsoft"},{"field":"version","operator":"IS NOT NULL"}],"limit":25,"orderBy":"vendor","page":1},"schema":{"$ref":"#/components/schemas/ListQuery"}}},"description":"Search, filter, paginate, and order technologies. Allowed filter and order fields: `comment`, `created`, `key`, `name`, `product`, `source`, `tags`, `updated`, `vendor`, `version`.","in":"query","name":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"description":"Resources in this page.","items":{"description":"Resources in this page.","properties":{"created":{"description":"Creation timestamp.","type":"string"},"key":{"description":"Stable technology identifier.","type":"string"},"name":{"description":"Technology name.","type":"string"},"product":{"description":"Technology product.","type":"string"},"source":{"description":"System that discovered the technology.","type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"updated":{"description":"Last observation timestamp.","type":"string"},"vendor":{"description":"Technology vendor.","type":"string"},"version":{"description":"Detected version.","type":"string"}},"required":["created","key","updated"],"type":"object"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"List technologies"},"patch":{"description":"Updates the supplied fields on an existing technology.","operationId":"patchTechnology","requestBody":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"Stable technology identifier.","type":"string"},"tags":{"description":"Replacement customer-defined labels.","items":{"description":"Replacement customer-defined labels.","type":"string"},"nullable":true,"type":"array"}},"required":["key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"key":{"description":"Stable technology identifier.","type":"string"},"name":{"description":"Technology name.","type":"string"},"product":{"description":"Technology product.","type":"string"},"source":{"description":"System that discovered the technology.","type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"updated":{"description":"Last observation timestamp.","type":"string"},"vendor":{"description":"Technology vendor.","type":"string"},"version":{"description":"Detected version.","type":"string"}},"required":["created","key","updated"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Update a technology"}},"/api/v1/vulnerabilities":{"get":{"description":"Returns vulnerabilities matching the supplied full-text search and filters.","operationId":"listVulnerabilities","parameters":[{"content":{"application/json":{"example":{"descending":true,"filters":[{"field":"cvss_score","operator":"=","value":7}],"limit":25,"orderBy":"priority","page":1},"schema":{"$ref":"#/components/schemas/ListQuery"}}},"description":"Search, filter, paginate, and order vulnerabilities. Allowed filter and order fields: `created`, `cvss_score`, `cvss_vector`, `cwe_codes`, `dns`, `key`, `name`, `priority`, `source`, `status`, `title`, `updated`.","in":"query","name":"query"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"description":"Resources in this page.","items":{"description":"Resources in this page.","properties":{"created":{"description":"Creation timestamp.","type":"string"},"cvss_score":{"description":"CVSS base score.","format":"float","nullable":true,"type":"number"},"cvss_vector":{"description":"CVSS vector string.","type":"string"},"cwe_codes":{"description":"Associated CWE identifiers.","items":{"description":"Associated CWE identifiers.","type":"string"},"type":"array"},"dns":{"description":"Affected DNS name.","type":"string"},"key":{"description":"Stable vulnerability identifier.","type":"string"},"name":{"description":"Vulnerability name.","type":"string"},"priority":{"description":"Guard priority score.","type":"integer"},"source":{"description":"System that discovered the vulnerability.","type":"string"},"status":{"description":"Remediation status.","type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"title":{"description":"Display title.","type":"string"},"updated":{"description":"Last update timestamp.","type":"string"}},"required":["created","dns","key","name","priority","source","status","updated"],"type":"object"},"type":"array"}},"required":["items"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"List vulnerabilities"},"patch":{"description":"Updates the supplied fields on an existing vulnerability.","operationId":"patchVulnerabilities","requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"description":"New history note; existing notes are preserved.","nullable":true,"type":"string"},"key":{"description":"Stable vulnerability identifier.","type":"string"},"status":{"description":"Replacement remediation status.","nullable":true,"type":"string"},"tags":{"description":"Replacement customer-defined labels.","items":{"description":"Replacement customer-defined labels.","type":"string"},"nullable":true,"type":"array"},"title":{"description":"Replacement display title.","nullable":true,"type":"string"}},"required":["key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"created":{"description":"Creation timestamp.","type":"string"},"cvss_score":{"description":"CVSS base score.","format":"float","nullable":true,"type":"number"},"cvss_vector":{"description":"CVSS vector string.","type":"string"},"cwe_codes":{"description":"Associated CWE identifiers.","items":{"description":"Associated CWE identifiers.","type":"string"},"type":"array"},"dns":{"description":"Affected DNS name.","type":"string"},"key":{"description":"Stable vulnerability identifier.","type":"string"},"name":{"description":"Vulnerability name.","type":"string"},"priority":{"description":"Guard priority score.","type":"integer"},"source":{"description":"System that discovered the vulnerability.","type":"string"},"status":{"description":"Remediation status.","type":"string"},"tags":{"description":"Customer-defined labels.","items":{"description":"Customer-defined labels.","type":"string"},"type":"array"},"title":{"description":"Display title.","type":"string"},"updated":{"description":"Last update timestamp.","type":"string"}},"required":["created","dns","key","name","priority","source","status","updated"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"Request error.","properties":{"code":{"description":"Stable machine-readable error code.","type":"string"},"message":{"description":"Human-readable error message.","type":"string"}},"required":["code","message"],"type":"object"}},"required":["error"],"type":"object"}}},"description":"Internal Server Error"}},"summary":"Update a vulnerability"}}},"security":[{"account":[],"oauth2":[]}],"servers":[{"url":"https://api.app.guard.praetorian.com"}]}