### Get Program
Source: https://api.yeswehack.com/doc.json
Retrieves the details of a specific program using its slug or PID.
```APIDOC
## GET /programs/{slugOrPid}
### Description
Get the current program.
### Method
GET
### Endpoint
/programs/{slugOrPid}
### Parameters
#### Path Parameters
- **slugOrPid** (string) - Required - Slug or pid of the program
### Responses
#### Success Response (200)
- Description: Retrieve program information
```
--------------------------------
### Get Program Version List
Source: https://api.yeswehack.com/doc.json
Retrieve a list of all available versions for a specific program.
```APIDOC
## GET /programs/{slug}/versions
### Description
Retrieve the versions of program.
### Method
GET
### Endpoint
/programs/{slug}/versions
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Response
#### Success Response (200)
- **items** (array) - The versions list of program
```
--------------------------------
### Get Program Pentest Campaigns List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of pentest campaigns for a given program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns
### Description
Get the campaign list for a program.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Response
#### Success Response (200)
- **items** (array) - List the program's campaigns
```
--------------------------------
### Get Host Services
Source: https://api.yeswehack.com/doc.json
Retrieve the services associated with a specific host.
```APIDOC
## POST /v2/asm/hosts/{hostId}/services
### Description
Retrieve the services of an host.
### Method
POST
### Endpoint
/v2/asm/hosts/{hostId}/services
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The ID of the host.
#### Query Parameters
- **page** (string) - Optional - Page to show. Defaults to 1.
### Response
#### Success Response (200)
- The services of the host are returned in the response body.
#### Response Example
{
"example": "ServicesResponseDto"
}
```
--------------------------------
### Get Program Thanks
Source: https://api.yeswehack.com/doc.json
Retrieves the list of thanks hunters for a specific program, with options for pagination.
```APIDOC
## GET /programs/{slug}/thanks
### Description
Retrieve the thanks on the platform attached to a program.
### Method
GET
### Endpoint
/programs/{slug}/thanks
### Parameters
#### Path Parameters
- **slug** (string) - Required - Slug of the program
#### Query Parameters
- **page** (string) - Optional - Page to show. Defaults to 1. Must be between 1 and 10000.
- **resultsPerPage** (string) - Optional - Number of results per page to show. Defaults to 12. Must be between 1 and 100.
### Response
#### Success Response (200)
- **items** (array) - The thanks list.
- **pagination** (object) - Pagination details.
#### Response Example
{
"items": [
{
"id": "string",
"reporter_id": "string",
"reporter_username": "string",
"reporter_gravatar": "string",
"program_id": "string",
"created_at": "string"
}
],
"pagination": {
"total": "number",
"count": "number",
"per_page": "number",
"current_page": "number",
"next_page": "number",
"previous_page": "number",
"next_page_url": "string",
"previous_page_url": "string"
}
}
```
--------------------------------
### Get Program Hunters List
Source: https://api.yeswehack.com/doc.json
Retrieves the list of hunters for a specific program.
```APIDOC
## GET /programs/{slug}/hunters
### Description
Get the program hunters list.
### Method
GET
### Endpoint
/programs/{slug}/hunters
### Parameters
#### Path Parameters
- **slug** (string) - Required - Slug of the program
```
--------------------------------
### Get Program Pentest Campaign Detail
Source: https://api.yeswehack.com/doc.json
Retrieves the details of a specific pentest campaign for a program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns/{id}
### Description
Get the campaign detail for a program.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns/{id}
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
- **id** (integer) - Required - id of the campaign
```
--------------------------------
### Get Host Coverage
Source: https://api.yeswehack.com/doc.json
Retrieve the coverage details for a specific host, with optional pagination.
```APIDOC
## POST /v2/asm/hosts/{hostId}/coverage
### Description
Retrieve the coverage of an host.
### Method
POST
### Endpoint
/v2/asm/hosts/{hostId}/coverage
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The ID of the host.
#### Query Parameters
- **page** (string) - Optional - Page to show. Defaults to 1.
- **resultsPerPage** (string) - Optional - Number of results per page to show. Defaults to 25.
#### Request Body
- **AttackSurfaceHostCoverageFilterType** - Required - The filter type for host coverage.
### Responses
#### Success Response (200)
- **items** (array) - List of the coverage for one host.
- **pagination** - Pagination details.
#### Response Example
```json
{
"items": [
{
"example": "AttackSurfaceHostCoverage"
}
],
"pagination": {
"example": "pagination"
}
}
```
```
--------------------------------
### Get Program Wallet Information
Source: https://api.yeswehack.com/doc.json
Retrieve balance amount information of the wallet attached to the program.
```APIDOC
## GET /programs/{slug}/wallet
### Description
Retrieve balance amount information of the wallet attached to the program.
### Method
GET
### Endpoint
/programs/{slug}/wallet
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Response
#### Success Response (200)
- **Wallet** - Retrieve wallet information
```
--------------------------------
### Get Host Details
Source: https://api.yeswehack.com/doc.json
Retrieve detailed information about a specific host using its ID.
```APIDOC
## GET /v2/asm/hosts/{hostId}
### Description
Retrieve host details.
### Method
GET
### Endpoint
/v2/asm/hosts/{hostId}
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The ID of the host to retrieve details for. Must be a 1-9 digit string.
### Response
#### Success Response (200)
- Details of the host are returned in the response body, conforming to the HostDetailsResponseDto schema.
#### Response Example
{
"example": "HostDetailsResponseDto"
}
```
--------------------------------
### Get Sub Hosts List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of hosts associated with a primary asset.
```APIDOC
## POST /v2/asm/primary-assets/{primaryAssetId}/hosts
### Description
Retrieve the list of hosts under the primary asset
### Method
POST
### Endpoint
/v2/asm/primary-assets/{primaryAssetId}/hosts
### Parameters
#### Path Parameters
- **primaryAssetId** (integer) - Required - id of the asset
```
--------------------------------
### Get Pentest Campaign Detail
Source: https://api.yeswehack.com/doc.json
Retrieves the details of a specific pentest campaign for a given program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns/{id}
### Description
Get a pentest campaign detail.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns/{id}
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
- **id** (integer) - Required - id of the campaign
### Responses
#### Success Response (200)
- **PentestCampaignDetail** (object) - Pentest Campaign detail.
```
--------------------------------
### Get Hunter Invitation List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of hunter invitations for a given program.
```APIDOC
## GET /programs/{slug}/hunters/invitations
### Description
Get the program hunter invitation list.
### Method
GET
### Endpoint
/programs/{slug}/hunters/invitations
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the program.
### Response
#### Success Response (200)
- **items** (array) - A list of invitation objects.
```
--------------------------------
### Get Report Support Questions
Source: https://api.yeswehack.com/doc.json
Retrieves the list of support questions associated with a report.
```APIDOC
## GET /reports/{id}/support-questions
### Description
Get the support questions list.
### Method
GET
### Endpoint
/reports/{id}/support-questions
### Parameters
#### Path Parameters
- **id** (integer) - Required - Report id
### Responses
#### Success Response (200)
- **items** (array) - Retrieve the report support questions list
- **SupportQuestionResponseDto** (object)
#### Error Responses
- **401** - UnauthorizedError
- **403** - AccessDenied
- **404** - NotFound
```
--------------------------------
### Get Potential Leaders
Source: https://api.yeswehack.com/doc.json
Retrieves a list of potential leaders for a pentest campaign within a program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns/potential-leaders
### Description
Get potential leaders for a campaign.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns/potential-leaders
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Responses
#### Success Response (200)
- **items** (array) - Array of UserEmbed objects representing potential leaders.
```
--------------------------------
### Get Program Pentest Campaigns
Source: https://api.yeswehack.com/doc.json
Retrieves a list of pentest campaigns associated with a specific program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns
### Description
Get all pentest campaigns for a program.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Responses
#### Success Response (200)
- **items** (array) - List of PentestCampaignDetail objects.
```
--------------------------------
### Get Program Member Invitation List
Source: https://api.yeswehack.com/doc.json
Retrieve the list of member invitations for a given program.
```APIDOC
## GET /programs/{slug}/members/invitations
### Description
Get the program member invitation list.
### Method
GET
### Endpoint
/programs/{slug}/members/invitations
### Parameters
#### Path Parameters
- **slug** (string) - Required -
### Responses
#### Success Response (200)
- Description: Retrieve the members invitation list
- Content:
- application/json:
- Schema:
- type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Invitation"
```
--------------------------------
### Get Host Detected Issues Counter
Source: https://api.yeswehack.com/doc.json
Get the count of detected issues for a specific host.
```APIDOC
## GET /v2/asm/hosts/{hostId}/detected-issues/counter
### Description
Get host detected issues counter.
### Method
GET
### Endpoint
/v2/asm/hosts/{hostId}/detected-issues/counter
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The ID of the host.
### Response
#### Success Response (200)
- **description** (string) - Number of host vulnerability reports. Example: 42
```
--------------------------------
### Create Program Pentest Campaign
Source: https://api.yeswehack.com/doc.json
Creates a new pentest campaign for a given program.
```APIDOC
## POST /programs/{slug}/pentest-campaigns
### Description
Create a campaign for a program.
### Method
POST
### Endpoint
/programs/{slug}/pentest-campaigns
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Response
#### Success Response (200)
- **Pentest Campaign detail** (object) - Pentest Campaign detail
```
--------------------------------
### Create Program
Source: https://api.yeswehack.com/doc.json
Creates a new program for a given business unit and program type.
```APIDOC
## POST /business-units/{slug}/programs/{type}
### Description
Create a new program for a given business unit and program type.
### Method
POST
### Endpoint
/business-units/{slug}/programs/{type}
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
- **type** (string) - Required - type of program. Allowed values: bug-bounty, vdp, pentest, vdp-in-app
### Request Body
- **schema** (oneOf) - Required - The schema for creating the program, which varies based on the program type.
### Response
#### Success Response (200)
- **schema** (oneOf) - The details of the created program, which varies based on the program type.
#### Error Responses
- **400** - Validation Failed
- **401** - Unauthorized Error
- **403** - Access Denied
- **404** - Not Found
```
--------------------------------
### Get Filters Data Programs
Source: https://api.yeswehack.com/doc.json
Retrieves filter data for programs. This endpoint allows you to get filter options that can be applied to program queries.
```APIDOC
## GET /programs/filters-data
### Description
Get filters data from programs.
### Method
GET
### Endpoint
/programs/filters-data
### Parameters
#### Query Parameters
- **filter** (object) - Optional - Example: `?filter[search]=value`
- **type** (array) - Optional -
- items: (string)
### Responses
#### Success Response (200)
- Description: Retrieve filters data from available programs
```
--------------------------------
### Get Available Users for Hunting
Source: https://api.yeswehack.com/doc.json
Retrieves a list of users available to be added as hunters to a program.
```APIDOC
## GET /programs/{slug}/hunters/users-available
### Description
Get available users for hunting.
### Method
GET
### Endpoint
/programs/{slug}/hunters/users-available
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier of the program.
#### Query Parameters
- **filter** (string) - Optional - Filter criteria for available users.
```
--------------------------------
### Get ASM findings count by status
Source: https://api.yeswehack.com/doc.json
Get the status counters of ASM findings. This endpoint accepts a filter object in the request body.
```APIDOC
## POST /asm/findings/count/status
### Description
Get the status counters of ASM findings. This endpoint accepts a filter object in the request body.
### Method
POST
### Endpoint
/asm/findings/count/status
### Request Body
- **AttackSurfaceFindingFilterType** - Schema reference for the request body.
### Request Example
{
"example": "request body"
}
### Response
#### Success Response (200)
- **AttackSurfaceFindingStatusCounterResponseDto** - Schema reference for the response body.
#### Response Example
{
"example": "response body"
}
```
--------------------------------
### Get Technology Instances List
Source: https://api.yeswehack.com/doc.json
Retrieve a paginated list of technology instances based on specified criteria.
```APIDOC
## POST /v2/asm/technologies/{part}/{vendor}/{product}/instances
### Description
Retrieve the list of technology instances.
### Method
POST
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/instances
### Parameters
#### Path Parameters
- **part** (string) - Required -
- **vendor** (string) - Required -
- **product** (string) - Required -
#### Query Parameters
- **page** (string) - Optional - Page to show. Defaults to 1. Pattern: [1-9]\d*
- **resultsPerPage** (string) - Optional - Number of results per page to show. Defaults to 25. Pattern: ^[1-9][0-9]?$|^100$
#### Request Body
- **AttackSurfaceTechnologyInstancesFilterType** (object) - Required -
### Response
#### Success Response (200)
- **items** (array) - Description: List of the technology instances. Items are of type TechnologyInstancesListResponseDto.
- **pagination** (object) - Description: Pagination details.
#### Response Example
{
"items": [
{
"id": "string",
"name": "string",
"version": "string",
"description": "string",
"technology_id": "string",
"technology_name": "string",
"technology_vendor": "string",
"technology_product": "string",
"first_seen": "string",
"last_seen": "string",
"ports": [
{
"port": 0,
"protocol": "string",
"service": "string",
"ssl_enabled": true
}
],
"locations": [
{
"country": "string",
"country_code": "string",
"city": "string",
"region": "string",
"latitude": 0,
"longitude": 0
}
],
"ip_addresses": [
"string"
],
"hostnames": [
"string"
],
"urls": [
"string"
],
"vulnerabilities_count": 0,
"critical_vulnerabilities_count": 0,
"high_vulnerabilities_count": 0,
"medium_vulnerabilities_count": 0,
"low_vulnerabilities_count": 0,
"cvss_max_score": 0
}
],
"pagination": {
"total_items": 0,
"total_pages": 0,
"current_page": 0,
"results_per_page": 0
}
}
```
--------------------------------
### Get Business Unit List
Source: https://api.yeswehack.com/doc.json
Retrieve the list of business units the user is a member of.
```APIDOC
## GET /business-units
### Description
Retrieve the list of the business unit in which the user is member.
### Method
GET
### Endpoint
/business-units
### Parameters
#### Query Parameters
- **reportsView** (integer) - Optional - When set to 1, show unread reports count per program in response. Defaults to 0.
### Response
#### Success Response (200)
- **(object)** - List of the business unit.
```
--------------------------------
### Create Program Methodology
Source: https://api.yeswehack.com/doc.json
Allows the creation of a new program methodology.
```APIDOC
## POST /programs/methodologies
### Description
Create program methodology
### Method
POST
### Endpoint
/programs/methodologies
### Request Body
- **schema** (object) - Required - The schema for the program methodology.
### Response
#### Success Response (200)
- **description**: Program methodology created
- **content**: application/json - The created program methodology.
#### Error Responses
- 400: Validation Failed
- 401: Unauthorized Error
- 503: Service Unavailable
```
--------------------------------
### Get ASM Detected Issues Count Status
Source: https://api.yeswehack.com/doc.json
Get the status count of detected issues within the Attack Surface Management system, with optional filtering.
```APIDOC
## POST /asm/detected-issues/count/status
### Description
Get the ASM detected issues' count status.
### Method
POST
### Endpoint
/asm/detected-issues/count/status
### Request Body
- **schema**: AttackSurfaceDetectedIssueFilterData
### Responses
#### Success Response (200)
- **description**: Retrieve ASM detected issues' count status
- **content**: application/json
- **schema**: object
- **pending** (integer)
- **ignored** (integer)
- **confirmed** (integer)
- **closed** (integer)
#### Response Example
{
"pending": 10,
"ignored": 5,
"confirmed": 20,
"closed": 15
}
```
--------------------------------
### Create Program Hunter Invitations (Bulk)
Source: https://api.yeswehack.com/doc.json
Allows for the creation of multiple program hunter invitations at once by providing a list of emails or usernames.
```APIDOC
## POST /programs/{slug}/hunters/bulk-invitations
### Description
Create program hunter invitations.
### Method
POST
### Endpoint
/programs/{slug}/hunters/bulk-invitations
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the program.
#### Request Body
- **emails_or_usernames** (array[string]) - Required - Collection of emails or usernames.
### Request Example
```json
{
"emails_or_usernames": [
"hunter1@example.com",
"hunter2"
]
}
```
### Response
#### Success Response (200)
- **items** (array[string]) - Description of successful invitations.
- **errors** (array[string]) - Description of any errors encountered during invitation creation.
```
--------------------------------
### Get Technology CVE Hosts Filters
Source: https://api.yeswehack.com/doc.json
Retrieve the technology CVE hosts filter options list. This endpoint allows you to get a list of available filters for CVE hosts associated with a specific technology part, vendor, and product.
```APIDOC
## GET /v2/asm/technologies/{part}/{vendor}/{product}/filters/cve/hosts
### Description
Retrieve the technology CVE hosts filter options list.
### Method
GET
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/filters/cve/hosts
### Parameters
#### Path Parameters
- **part** (string) - Required - The technology part identifier.
- **vendor** (string) - Required - The vendor identifier.
- **product** (string) - Required - The product identifier.
#### Query Parameters
- **filter** (object) - Optional - Allows filtering by business unit slugs. Example: `?filter[businessUnitSlugs][]=my-business-unit-slug&filter[businessUnitSlugs][]=my-second-business-unit-slug`
- **businessUnitSlugs** (array[string]) - Optional - A list of business unit slugs to filter by.
### Response
#### Success Response (200)
- **items** (array[string]) - A list of filter hosts.
```
--------------------------------
### Get Report Logs
Source: https://api.yeswehack.com/doc.json
Lists the logs for a specific report.
```APIDOC
## GET /reports/{id}/logs
### Description
List the report logs for the given report.
### Method
GET
### Endpoint
/reports/{id}/logs
### Parameters
#### Path Parameters
- **id** (integer) - Required - Id of the report.
### Responses
#### Success Response (200)
- **items** (array) - An array of ReportLogDetail objects.
#### Response Example
{
"items": [
{
"id": 1,
"report_id": 1,
"message": "Report created.",
"created_at": "2023-01-01T09:00:00Z",
"user": {
"id": 1,
"username": "user1"
}
}
]
}
```
--------------------------------
### Create Program Report Import
Source: https://api.yeswehack.com/doc.json
Creates a new program report import for a given program.
```APIDOC
## POST /api/programs/{program_slug}/report_imports
### Description
Creates a program report import.
### Method
POST
### Endpoint
/api/programs/{program_slug}/report_imports
### Parameters
#### Path Parameters
- **program_slug** (string) - Required - The unique identifier for the program.
#### Request Body
- **ReportImportCreateType** (object) - Required - The details for creating the report import.
### Request Example
{
"report_type": "string",
"file": "file"
}
### Response
#### Success Response (200)
- **ReportImport** (object) - The details of the created report import.
#### Response Example
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"program_slug": "string",
"report_type": "string",
"status": "string",
"file_name": "string",
"file_url": "string",
"error_message": "string"
}
```
--------------------------------
### Get Technologies Counters
Source: https://api.yeswehack.com/doc.json
Retrieve the counters of technologies with filtering options.
```APIDOC
## GET /v2/asm/technologies/counters
### Description
Retrieve the counters of technologies.
### Method
GET
### Endpoint
/v2/asm/technologies/counters
### Parameters
#### Query Parameters
- **filter** (object) - Optional - Allows filtering technologies by various criteria.
- **businessUnitSlugs** (array[string]) - Optional - Filter by business unit slugs.
### Responses
#### Success Response (200)
- **items** (array[TechnologyListCounterResponseDto]) - A list of technology counters.
- **pagination** - Pagination information.
#### Error Responses
- **400** - Validation Failed
- **401** - Unauthorized Error
- **404** - Not Found
- **503** - Service Unavailable
```
--------------------------------
### Get Technologies List
Source: https://api.yeswehack.com/doc.json
Retrieve a list of technologies with filtering options.
```APIDOC
## GET /v2/asm/technologies
### Description
Retrieve a list of technologies with filtering options.
### Method
GET
### Endpoint
/v2/asm/technologies
### Parameters
#### Query Parameters
- **filter** (object) - Optional - Allows filtering technologies by various criteria.
- **businessUnitSlugs** (array[string]) - Optional - Filter by business unit slugs.
### Responses
#### Success Response (200)
- **items** (array[TechnologyListResponseDto]) - A list of technologies.
- **pagination** - Pagination information.
#### Error Responses
- **400** - Validation Failed
- **401** - Unauthorized Error
- **404** - Not Found
- **503** - Service Unavailable
```
--------------------------------
### Get Host Vulnerabilities
Source: https://api.yeswehack.com/doc.json
Retrieve the vulnerabilities associated with a specific host.
```APIDOC
## POST /v2/asm/hosts/{hostId}/vulnerabilities
### Description
Retrieve the vulnerabilities of an host
### Method
POST
### Endpoint
/v2/asm/hosts/{hostId}/vulnerabilities
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The ID of the host for which to retrieve vulnerabilities.
### Responses
#### Success Response (200)
- [Schema details not provided in source]
#### Error Responses
- [Error response details not provided in source]
```
--------------------------------
### Create SSO Configuration
Source: https://api.yeswehack.com/doc.json
Creates a new SSO configuration for a specified business unit.
```APIDOC
## POST /api/business-units/{slug}/sso-configurations
### Description
Create a new SSO configuration for the business unit.
### Method
POST
### Endpoint
/api/business-units/{slug}/sso-configurations
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
### Request Body
- **SsoConfigurationCreateType** - Required - The schema for creating an SSO configuration.
### Response
#### Success Response (200)
- **SsoConfiguration** - The created SSO configuration.
```
--------------------------------
### Get members list
Source: https://api.yeswehack.com/doc.json
Retrieves the list of members associated with a report.
```APIDOC
## GET /reports/{id}/members
### Description
Get the report members list.
### Method
GET
### Endpoint
/reports/{id}/members
### Parameters
#### Path Parameters
- **id** (string) - Required
### Responses
#### Success Response (200)
- Description: Retrieve the members list
- Content: application/json (schema: object with items array of Member)
#### Error Responses
- 401: UnauthorizedError
- 404: NotFound
```
--------------------------------
### Create Assets
Source: https://api.yeswehack.com/doc.json
Creates new assets for a given business unit.
```APIDOC
## POST /api/business_unit/{slug}/asm/asset/create_bulk
### Description
Create new assets in bulk for a specific business unit.
### Method
POST
### Endpoint
/api/business_unit/{slug}/asm/asset/create_bulk
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
#### Request Body
- **assets** (array) - Required - List of assets to create.
- **name** (string) - Required - Name of the asset.
- **type** (string) - Required - Type of the asset (e.g., domain, ip).
```
--------------------------------
### Get Slack Channels List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of Slack channels available for a business unit.
```APIDOC
## GET /business-units/{slug}/slack/channels
### Description
Retrieve list of slack channels for the business unit.
### Method
GET
### Endpoint
/business-units/{slug}/slack/channels
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
### Responses
#### Success Response (200)
- Description: List of slack channels available for the business unit
- Content: application/json
- Schema:
- type: object
- properties:
- items:
- type: array
- items: #/components/schemas/SlackChannel
```
--------------------------------
### Get Report Log
Source: https://api.yeswehack.com/doc.json
Retrieves the log details for a specific report.
```APIDOC
## GET /reports/{id}/log
### Description
Get a report log.
### Method
GET
### Endpoint
/reports/{id}/log
### Parameters
#### Path Parameters
- **id** (integer) - Required - Report id
### Responses
#### Success Response (200)
- **ReportLogDetail** (object) - Get a report Log
#### Error Responses
- **204** - Report has not been modified by the request payload
- **404** - NotFound
- **401** - UnauthorizedError
- **403** - AccessDenied
```
--------------------------------
### Create Program Hunter Invitation
Source: https://api.yeswehack.com/doc.json
Creates a hunter invitation for a program.
```APIDOC
## POST /programs/{slug}/hunters/invitations
### Description
Create a program hunter invitation.
### Method
POST
### Endpoint
/programs/{slug}/hunters/invitations
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the program.
#### Request Body
- **email_or_username** (string) - Required - Email or username of the hunter to invite.
### Response
#### Success Response (200)
- [Description of success response not fully provided in source]
```
--------------------------------
### Get Report Detail
Source: https://api.yeswehack.com/doc.json
Retrieves detailed information about a specific report.
```APIDOC
## GET /reports/{id}
### Description
Retrieve information of report.
### Method
GET
### Endpoint
/reports/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - id of the report.
```
--------------------------------
### List SSO Configurations
Source: https://api.yeswehack.com/doc.json
Retrieves a list of all SSO configurations for a specified business unit.
```APIDOC
## GET /api/business-units/{slug}/sso-configurations
### Description
List SSO configurations of the business unit.
### Method
GET
### Endpoint
/api/business-units/{slug}/sso-configurations
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
### Response
#### Success Response (200)
- **items** (array) - List of SSO configurations
```
--------------------------------
### Create attachment file for Program
Source: https://api.yeswehack.com/doc.json
Allows the creation of an attachment file associated with a specific program, identified by its slug.
```APIDOC
## POST /programs/{slug}/attachments
### Description
Create an attachment file for the program.
### Method
POST
### Endpoint
/programs/{slug}/attachments
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier of the program.
### Response
#### Success Response (200)
- **items** (array) - An array of attachment objects.
- **items** (object) - Represents an attachment.
- **$ref**: "#/components/schemas/Attachment"
#### Error Responses
- **400**: Validation Failed
- **403**: Access Denied
- **404**: Not Found
- **503**: Service Unavailable
```
--------------------------------
### Get Report Draft
Source: https://api.yeswehack.com/doc.json
Retrieves the draft of a report for a given program.
```APIDOC
## GET /programs/{slug}/reports/draft
### Description
Retrieves the draft of a report for a given program.
### Method
GET
### Endpoint
/programs/{slug}/reports/draft
### Parameters
#### Path Parameters
- **slug** (string) - Required - The slug of the program.
```
--------------------------------
### Get Vulnpedia Statistics
Source: https://api.yeswehack.com/doc.json
Retrieves statistical information about vulnerabilities in the Vulnpedia.
```APIDOC
## GET /asm/vulnpedia/statistics
### Description
Get statistics for Vulnpedia.
### Method
GET
### Endpoint
/asm/vulnpedia/statistics
```
--------------------------------
### Get Technology Instances Counter
Source: https://api.yeswehack.com/doc.json
Retrieve the count of technology instances for a given part, vendor, and product.
```APIDOC
## GET /v2/asm/technologies/{part}/{vendor}/{product}/instances/counter
### Description
Retrieve technology instances counter.
### Method
GET
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/instances/counter
### Parameters
#### Path Parameters
- **part** (string) - Required - The part of the technology.
- **vendor** (string) - Required - The vendor of the technology.
- **product** (string) - Required - The product of the technology.
### Response
#### Success Response (200)
- **integer** - Number of technology instances.
### Response Example
```
42
```
```
--------------------------------
### Get Host Filters
Source: https://api.yeswehack.com/doc.json
Retrieve the list of filters applied to a specific host.
```APIDOC
## GET /v2/asm/hosts/{hostId}/filters
### Description
Retrieve the list of filters applied to a specific host.
### Method
GET
### Endpoint
/v2/asm/hosts/{hostId}/filters
### Parameters
#### Path Parameters
- **hostId** (integer) - Required - The ID of the host.
```
--------------------------------
### Get Host Vulnerabilities Counter
Source: https://api.yeswehack.com/doc.json
Retrieves a count of vulnerabilities for a specific host.
```APIDOC
## GET /v2/asm/hosts/{hostId}/vulnerabilities/counter
### Description
Retrieves the total count of vulnerabilities for a given host.
### Method
GET
### Endpoint
/v2/asm/hosts/{hostId}/vulnerabilities/counter
### Parameters
#### Path Parameters
- **hostId** (string) - Required - The unique identifier of the host.
### Response
#### Success Response (200)
- **count** (integer) - The total number of vulnerabilities for the host.
#### Response Example
```json
{
"count": 50
}
```
```
--------------------------------
### Create Program Hunter User Invitation
Source: https://api.yeswehack.com/doc.json
Creates an invitation for a specific user to join a program.
```APIDOC
## POST /programs/{slug}/hunters/invitations/add/{user_slug}
### Description
Creates an invitation for a specific user to join a program.
### Method
POST
### Endpoint
/programs/{slug}/hunters/invitations/add/{user_slug}
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the program.
- **user_slug** (string) - Required - The unique identifier for the user.
### Response
#### Success Response (200)
- **Invitation** (object) - Details of the created invitation.
#### Response Example
{
"id": "inv_123",
"user_id": "usr_456",
"program_id": "prg_789",
"status": "pending",
"created_at": "2023-10-27T10:00:00Z"
}
```
--------------------------------
### Get asset's scan history
Source: https://api.yeswehack.com/doc.json
Retrieves the scan history of the asset.
```APIDOC
## GET /v2/asm/assets/{assetId}/scan-history
### Description
Get the scan history of the asset.
### Method
GET
### Endpoint
/v2/asm/assets/{assetId}/scan-history
### Parameters
#### Path Parameters
- **assetId** (string) - Required - The ID of the asset.
#### Query Parameters
- **filter** (object) - Required - Used to filter the scan history. Example: `?filter[sortBy]=startDate&filter[order]=ASC`
- **scanTypes** (array) - Optional - Specifies the types of scans to filter by. Allowed values: "UNKNOWN", "DISCOVERY", "SECURITY_CHECK".
- **sortBy** (string) - Optional - Specifies the field to sort the results by. Allowed values: "startDate", "endDate", "scanType", "checkpoints".
- **page** (object) - Optional - Pagination parameters.
```
--------------------------------
### Export Instances by Technology
Source: https://api.yeswehack.com/doc.json
Export a list of instances by technology in CSV, JSON, or XLS format.
```APIDOC
## POST /v2/asm/technologies/{part}/{vendor}/{product}/instances/exports/{format}
### Description
Export list of instances by technology.
### Method
POST
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/instances/exports/{format}
### Parameters
#### Path Parameters
- **part** (string) - Required - The part of the technology.
- **vendor** (string) - Required - The vendor of the technology.
- **product** (string) - Required - The product of the technology.
- **format** (string) - Required - The export format (csv, json, xls).
### Response
#### Success Response (200)
- **string** - The exported data in the specified format.
```
--------------------------------
### Get Report Collaborators List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of collaborators for a specific report.
```APIDOC
## GET /reports/{id}/collaborators
### Description
Get the report collaborators list.
### Method
GET
### Endpoint
/reports/{id}/collaborators
### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the report.
### Responses
#### Success Response (200)
- **items** (array) - Description: A list of members associated with the report.
```
--------------------------------
### Get Technology Instances Hosts Filter Options List
Source: https://api.yeswehack.com/doc.json
Retrieve a list of filter options for technology instances hosts. This endpoint allows filtering by business unit slugs.
```APIDOC
## GET /v2/asm/technologies/{part}/{vendor}/{product}/filters/instances/hosts
### Description
Retrieve the technology instances hosts filter options list.
### Method
GET
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/filters/instances/hosts
### Parameters
#### Path Parameters
- **part** (string) - Required -
- **vendor** (string) - Required -
- **product** (string) - Required -
#### Query Parameters
- **filter** (object) - Optional - Example: `?filter[businessUnitSlugs][]=my-business-unit-slug&filter[businessUnitSlugs][]=my-second-business-unit-slug`
- **businessUnitSlugs** (array) - Optional -
- items: (string)
### Response
#### Success Response (200)
- **ItemsString** (object) - List of the filter hosts
```
--------------------------------
### Create Program Hunter Group Invitation
Source: https://api.yeswehack.com/doc.json
Creates an invitation for a group of hunters to join a program.
```APIDOC
## POST /programs/{slug}/hunters/invitations/group/create
### Description
Creates an invitation for a group of hunters to join a program.
### Method
POST
### Endpoint
/programs/{slug}/hunters/invitations/group/create
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the program.
#### Request Body
- **group** (integer) - Required - The identifier for the group of hunters.
### Response
#### Success Response (200)
- **items** (array) - A list of created invitations.
- **errors** (array) - A list of errors encountered during invitation creation.
#### Response Example
{
"items": [
{
"id": "inv_123",
"user_id": "usr_456",
"program_id": "prg_789",
"status": "pending",
"created_at": "2023-10-27T10:00:00Z"
}
],
"errors": []
}
```
--------------------------------
### Get Active Campaign
Source: https://api.yeswehack.com/doc.json
Retrieves the currently active pentest campaign for a program.
```APIDOC
## GET /programs/{slug}/pentest-campaigns/active-campaign
### Description
Get the active campaign for a program.
### Method
GET
### Endpoint
/programs/{slug}/pentest-campaigns/active-campaign
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the program
### Responses
#### Success Response (200)
- **PentestCampaignDetail** (object) - Pentest Campaign active.
```
--------------------------------
### Get Revoked Hunters
Source: https://api.yeswehack.com/doc.json
Retrieves a list of revoked hunters for a specific program.
```APIDOC
## GET /programs/{slug}/hunters/revoked
### Description
Get the revoked program hunters list.
### Method
GET
### Endpoint
/programs/{slug}/hunters/revoked
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier of the program.
### Response
#### Success Response (200)
- **items** (array) - A list of revoked hunter objects.
```
--------------------------------
### Create CVE Alert
Source: https://api.yeswehack.com/doc.json
Creates a new CVE alert for a specified business unit.
```APIDOC
## POST /api/business_unit/{slug}/asm/cve_alert
### Description
Create a new CVE alert for a specific business unit.
### Method
POST
### Endpoint
/api/business_unit/{slug}/asm/cve_alert
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
#### Request Body
- **cveId** (string) - Required - The CVE ID for the alert.
- **description** (string) - Optional - A description for the alert.
- **severity** (string) - Optional - The severity level of the alert (e.g., LOW, MEDIUM, HIGH, CRITICAL).
- **status** (string) - Optional - The status of the alert (e.g., OPEN, CLOSED, INVESTIGATING).
### Response
#### Success Response (204)
No Content
```
--------------------------------
### Get Business Unit Product List
Source: https://api.yeswehack.com/doc.json
Retrieves a list of products associated with a specific business unit. Requires the business unit's slug.
```APIDOC
## GET /business-units/{slug}/products
### Description
Get the list of business unit product.
### Method
GET
### Endpoint
/business-units/{slug}/products
### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique identifier for the business unit.
### Responses
#### Success Response (200)
- **items** (array) - A list of business unit products.
```
--------------------------------
### Get program ranking
Source: https://api.yeswehack.com/doc.json
Retrieve the ranking for hunters participating in a specific program.
```APIDOC
## GET /programs/{slug}/ranking
### Description
Retrieve the ranking for hunters of the program
### Method
GET
### Endpoint
/programs/{slug}/ranking
### Parameters
#### Path Parameters
- **slug** (string) - Required - Slug of the program
#### Query Parameters
- **page** (string) - Optional - Page to show. Defaults to 1.
- **resultsPerPage** (string) - Optional - Number of results per page to show. Defaults to 25.
```
--------------------------------
### Create Program Credentials
Source: https://api.yeswehack.com/doc.json
Allows for the creation of new credentials within a specified program and credential pool.
```APIDOC
## POST /api/programs/{program_slug}/credential-pools/{credential_pool_slug}/credentials
### Description
Create new credentials.
### Method
POST
### Endpoint
/api/programs/{program_slug}/credential-pools/{credential_pool_slug}/credentials
### Parameters
#### Path Parameters
- **program_slug** (string) - Required - slug of the program
- **credential_pool_slug** (string) - Required - slug of the credential pool
#### Request Body
- **CredentialsCollectionType** (object) - Required - Schema for a collection of credentials.
### Response
#### Success Response (200)
- **message** (string) - Description: Credentials created
```
--------------------------------
### Get Business Unit
Source: https://api.yeswehack.com/doc.json
Retrieve information of a business unit using its slug.
```APIDOC
## GET /business-units/{slug}
### Description
Retrieve information of the business unit attached to the slug.
### Method
GET
### Endpoint
/business-units/{slug}
### Parameters
#### Path Parameters
- **slug** (string) - Required - slug of the business unit
### Responses
#### Success Response (200)
- description: "Business unit information"
- content:
application/json:
schema:
"$ref": "#/components/schemas/BusinessUnitDetail"
#### Error Responses
- 401: "#/components/responses/401-UnauthorizedError"
- 404: "#/components/responses/404-NotFound"
```
--------------------------------
### Create Program Member Invitation
Source: https://api.yeswehack.com/doc.json
Create a new member invitation for a program.
```APIDOC
## POST /programs/{slug}/members/invitations
### Description
Create program member invitation.
### Method
POST
### Endpoint
/programs/{slug}/members/invitations
### Parameters
#### Path Parameters
- **slug** (string) - Required -
### Request Body
- Schema:
$ref: "#/components/schemas/ProgramMemberInvitationCreateType"
### Responses
#### Success Response (200)
- Description: Create program member invitation
- Content:
- application/json:
- Schema:
$ref: "#/components/schemas/Invitation"
```
--------------------------------
### Get Technology CVEs Counter
Source: https://api.yeswehack.com/doc.json
Retrieves the count of CVEs associated with a specific technology.
```APIDOC
## GET /v2/asm/technologies/{part}/{vendor}/{product}/cves/counter
### Description
Retrieves the total count of CVEs for a given technology part, vendor, and product.
### Method
GET
### Endpoint
/v2/asm/technologies/{part}/{vendor}/{product}/cves/counter
### Parameters
#### Path Parameters
- **part** (string) - Required - The part of the technology.
- **vendor** (string) - Required - The vendor of the technology.
- **product** (string) - Required - The product of the technology.
### Response
#### Success Response (200)
- **integer** - The number of technology CVEs.
#### Response Example
42
```