Reporting API (v1)

이 문서는 v1 API를 사용하며, Snyk은 향후 개발을 REST API에 집중할 예정이므로 결국 지원이 중단될 예정입니다. 자세한 내용은 v1 API를 참조하십시오.

이 카테고리의 엔드포인트는 최신 릴리스가 아닌 Snyk 레거시 보고(legacy reporting)만 지원합니다. 이 엔드포인트들은 싱글 테넌트 또는 멀티 테넌트 US02, EU 및 AU와 같은 지역에서는 사용할 수 없으며, 대신 Issues REST API를 사용하십시오.

Reporting API를 사용하여 조직에 얼마나 많은 문제가 있는지, 또는 특정 기간 동안 얼마나 많은 테스트가 수행되었는지와 같은 질문에 대한 답변을 찾을 수 있습니다.

속도 제한은 사용자당 분당 최대 70건의 요청입니다. 제한을 초과하는 모든 요청은 속도 제한 간격(1분) 동안 요청이 중단될 때까지 상태 코드 429 - Too many requests가 포함된 응답을 받게 됩니다.

Get list of issues

post

Returns any issues that are present during the specified timeframe. For example, if an issue from 2018 is still considered a vulnerable today, it will show up in all reports from its inception to the current day. This data can take up to 9 hours to refresh.Note: A vulnerability that was introduced and then resolved on the same day will not show up in the response.

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

fromstringRequired

The date you wish to fetch results from, in the format YYYY-MM-DD

Example: 2017-07-01

tostringRequired

The date you wish to fetch results until, in the format YYYY-MM-DD

Example: 2017-07-07

pagenumber · doubleOptional

The page of results to request

Example: 1

perPagenumber · doubleOptional

The number of results to return per page (Maximum: 1000)

Example: 100

sortByall ofOptional

The key to sort results by

string · enumOptionalPossible values:

and

anyOptional

The key to sort results by

Example: issueTitle

orderstringOptional

The direction to sort results.

Example: asc

groupByall ofOptional

Set to issue to group the same issue in multiple projects

string · enumOptionalPossible values:

and

anyOptional

Set to issue to group the same issue in multiple projects

Example: issue

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"severity":["critical","high","medium","low"],"exploitMaturity":["mature","proof-of-concept","no-known-exploit","no-data"],"types":["vuln","license","configuration"],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[],"issues":[],"identifier":"","ignored":false,"patched":false,"fixable":false,"isFixed":false,"isUpgradable":false,"isPatchable":false,"isPinnable":false,"priorityScore":{"min":0,"max":1000}}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/issues

HTTPcURLJavaScriptPython

POST /v1/reporting/issues?from=2017-07-01&to=2017-07-07 HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 540

{
  "filters": {
    "orgs": [],
    "severity": [
      "critical",
      "high",
      "medium",
      "low"
    ],
    "exploitMaturity": [
      "mature",
      "proof-of-concept",
      "no-known-exploit",
      "no-data"
    ],
    "types": [
      "vuln",
      "license",
      "configuration"
    ],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": [],
    "issues": [],
    "identifier": "",
    "ignored": false,
    "patched": false,
    "fixable": false,
    "isFixed": false,
    "isUpgradable": false,
    "isPatchable": false,
    "isPinnable": false,
    "priorityScore": {
      "min": 0,
      "max": 1000
    }
  }
}

{
  "results": [
    [
      {
        "url": "text",
        "id": "text",
        "name": "text",
        "source": "text",
        "packageManager": "text",
        "targetFile": "text"
      }
    ]
  ],
  "total": 1
}

Get list of latest issues

post

Returns issues currently in existence. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

pagenumber · doubleOptional

The page of results to request

Example: 1

perPagenumber · doubleOptional

The number of results to return per page (Maximum: 1000)

Example: 100

sortByall ofOptional

The key to sort results by

string · enumOptionalPossible values:

and

anyOptional

The key to sort results by

Example: issueTitle

orderstringOptional

The direction to sort results.

Example: asc

groupByall ofOptional

Set to issue to group the same issue in multiple projects

string · enumOptionalPossible values:

and

anyOptional

Set to issue to group the same issue in multiple projects

Example: issue

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"severity":["critical","high","medium","low"],"exploitMaturity":["mature","proof-of-concept","no-known-exploit","no-data"],"types":["vuln","license","configuration"],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[],"issues":[],"identifier":"","ignored":false,"patched":false,"fixable":false,"isFixed":false,"isUpgradable":false,"isPatchable":false,"isPinnable":false,"priorityScore":{"min":0,"max":1000}}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/issues/latest

HTTPcURLJavaScriptPython

POST /v1/reporting/issues/latest HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 540

{
  "filters": {
    "orgs": [],
    "severity": [
      "critical",
      "high",
      "medium",
      "low"
    ],
    "exploitMaturity": [
      "mature",
      "proof-of-concept",
      "no-known-exploit",
      "no-data"
    ],
    "types": [
      "vuln",
      "license",
      "configuration"
    ],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": [],
    "issues": [],
    "identifier": "",
    "ignored": false,
    "patched": false,
    "fixable": false,
    "isFixed": false,
    "isUpgradable": false,
    "isPatchable": false,
    "isPinnable": false,
    "priorityScore": {
      "min": 0,
      "max": 1000
    }
  }
}

{
  "results": [
    [
      {
        "url": "text",
        "id": "text",
        "name": "text",
        "source": "text",
        "packageManager": "text",
        "targetFile": "text"
      }
    ]
  ],
  "total": 1
}

Get test counts

post

Returns the number of tests conducted within a time frame. This data is updated in real time

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

fromstringRequired

The date you wish to count tests from, in the format YYYY-MM-DD

Example: 2017-07-01

tostringRequired

The date you wish to count tests until, in the format YYYY-MM-DD

Example: 2017-07-03

groupByall ofOptional

The field to group results by

string · enumOptionalPossible values:

and

anyOptional

The field to group results by

Example: isPrivate

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"isPrivate":false,"issuesPrevented":false,"projects":[]}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/counts/tests

HTTPcURLJavaScriptPython

POST /v1/reporting/counts/tests?from=2017-07-01&to=2017-07-03 HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "filters": {
    "orgs": [],
    "isPrivate": false,
    "issuesPrevented": false,
    "projects": []
  }
}

{
  "results": [
    {
      "count": 0,
      "isPrivate": {
        "true": 0,
        "false": 0
      }
    }
  ]
}

Get project counts

post

Returns project counts within a time frame. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

fromstringRequired

The date you wish to fetch results from, in the format YYYY-MM-DD

Example: 2017-07-01

tostringRequired

The date you wish to fetch results until, in the format YYYY-MM-DD

Example: 2017-07-03

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[]}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/counts/projects

HTTPcURLJavaScriptPython

POST /v1/reporting/counts/projects?from=2017-07-01&to=2017-07-03 HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "filters": {
    "orgs": [],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": []
  }
}

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0
    },
    {
      "day": "2017-07-02",
      "count": 0
    },
    {
      "day": "2017-07-03",
      "count": 0
    }
  ]
}

Get latest project counts

post

Returns the number of projects currently in existence. This data can take up to 9 hours to refresh.

• Params#### Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[]}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/counts/projects/latest

HTTPcURLJavaScriptPython

POST /v1/reporting/counts/projects/latest HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "filters": {
    "orgs": [],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": []
  }
}

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0
    }
  ]
}

Get issue counts

post

Returns issue counts within a time frame. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

fromstringRequired

The date you wish to fetch results from, in the format YYYY-MM-DD

Example: 2017-07-01

tostringRequired

The date you wish to fetch results until, in the format YYYY-MM-DD

Example: 2017-07-03

groupByall ofOptional

The field to group results by

string · enumOptionalPossible values:

and

anyOptional

The field to group results by

Example: severity

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"severity":["critical","high","medium","low"],"types":["vuln","license","configuration"],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[],"ignored":false,"patched":false,"fixable":false,"isUpgradable":false,"isPatchable":false,"isPinnable":false,"priorityScore":{"min":0,"max":1000}}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/counts/issues

HTTPcURLJavaScriptPython

POST /v1/reporting/counts/issues?from=2017-07-01&to=2017-07-03 HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "filters": {
    "orgs": [],
    "severity": [
      "critical",
      "high",
      "medium",
      "low"
    ],
    "types": [
      "vuln",
      "license",
      "configuration"
    ],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": [],
    "ignored": false,
    "patched": false,
    "fixable": false,
    "isUpgradable": false,
    "isPatchable": false,
    "isPinnable": false,
    "priorityScore": {
      "min": 0,
      "max": 1000
    }
  }
}

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    },
    {
      "day": "2017-07-02",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    },
    {
      "day": "2017-07-03",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    }
  ]
}

Get latest issue counts

post

Returns the number of issues currently in existence. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

Query parameters

groupByall ofOptional

The field to group results by

string · enumOptionalPossible values:

and

anyOptional

The field to group results by

Example: severity

Body

application/json

and

anyOptionalExample: {"filters":{"orgs":[],"severity":["critical","high","medium","low"],"types":["vuln","license","configuration"],"languages":["node","javascript","ruby","java","scala","python","golang","php","dotnet","swift-objective-c","elixir","docker","linux","dockerfile"],"projects":[],"ignored":false,"patched":false,"fixable":false,"isUpgradable":false,"isPatchable":false,"isPinnable":false,"priorityScore":{"min":0,"max":1000}}}

Responses

200Success

application/json

400Error

application/json

post

/reporting/counts/issues/latest

HTTPcURLJavaScriptPython

POST /v1/reporting/counts/issues/latest HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "filters": {
    "orgs": [],
    "severity": [
      "critical",
      "high",
      "medium",
      "low"
    ],
    "types": [
      "vuln",
      "license",
      "configuration"
    ],
    "languages": [
      "node",
      "javascript",
      "ruby",
      "java",
      "scala",
      "python",
      "golang",
      "php",
      "dotnet",
      "swift-objective-c",
      "elixir",
      "docker",
      "linux",
      "dockerfile"
    ],
    "projects": [],
    "ignored": false,
    "patched": false,
    "fixable": false,
    "isUpgradable": false,
    "isPatchable": false,
    "isPinnable": false,
    "priorityScore": {
      "min": 0,
      "max": 1000
    }
  }
}

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    }
  ]
}