/hackerone/programs/scopes

POST /api/hackerone/programs/scopes

Price: 1 credit

List structured in-scope assets of a HackerOne (hackerone.com) program

How to use it

List the structured in-scope assets (attack surface) of a HackerOne program by handle. Returns each asset identifier, asset type, max severity, bounty/submission eligibility, newly-added flag, system/reward tags, resolved report count, instructions and attachments. Filter by search, severity, asset type, and bounty/submission eligibility.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• handle string required — Program handle ('security') or program URL ('https://hackerone.com/security'). (examples: "security", "https://hackerone.com/security"; minLength: 1)
• count integer required — Max number of in-scope assets to return (min: 1)
• search string nullable — Filter assets by identifier substring
• eligible_for_submission boolean nullable — Only assets eligible for report submission
• eligible_for_bounty boolean nullable — Only assets eligible for a bounty
• min_severity string nullable — Only assets with at least this maximum severity (one of: "none", "low", "medium", "high", "critical")
• asset_types array nullable — Filter by structured scope asset type (one of: "CIDR", "URL", "APPLE_STORE_APP_ID", "TESTFLIGHT", "OTHER_IPA", "GOOGLE_PLAY_APP_ID", "OTHER_APK", "WINDOWS_APP_STORE_APP_ID", "SOURCE_CODE", "DOWNLOADABLE_EXECUTABLES", "SMART_CONTRACT", "WILDCARD", "IP_ADDRESS", "HARDWARE", "OTHER", "AI_MODEL", "API", "AWS_CLOUD_CONFIG", "AZURE_CLOUD_CONFIG")
• sort_direction string — Sort direction by max severity (default: "DESC"; one of: "DESC", "ASC")

Response

• @type string (default: "HackeroneScope")
• id string nullable
• identifier string required
• asset_type string nullable
• display_name string nullable
• instruction string nullable
• max_severity string nullable
• eligible_for_bounty boolean nullable
• eligible_for_submission boolean nullable
• is_new boolean nullable
• system_tags array (default: [])
• reward_tags array (default: [])
• resolved_report_count integer nullable
• created_at string nullable
• updated_at string nullable
• attachments array (default: [])
  • @type string (default: "HackeroneAttachment")
  • id string nullable
  • file_name string nullable
  • file_size integer nullable
  • content_type string nullable
  • url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Program not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.