PUT /api/projects and project items — update records

Use these endpoints to modify existing projects and their associated items. PUT /api/projects performs a full replacement of a project record. POST /api/projects/createProjectItem adds a new site or target to an existing project. PUT /api/projects/updateProjectItem updates an item’s name, type, access model, and location.

Update project
Create project item
Update project item

PUT /api/projects

PUT https://api-admin.hackgate.io/api/projects

Replaces an existing project record with the values you provide. Send the full project object — including all fields returned by GET /api/projects/{id} — with your changes applied. Omitting optional fields sets them to null.

Request

string

required

Bearer token. See Authentication.

string

required

Must be application/json.

Body parameters

string

required

The unique identifier of the project to update.

string

required

The organization that owns the project.

string

required

Human-readable project name.

string

Description of the project’s scope or purpose.

string

Free-text internal notes.

string

ISO 8601 date-time when the engagement starts.

string

ISO 8601 date-time when the engagement ends.

string

ISO 8601 date-time when the project was originally created. Pass through unchanged.

string

Identifier of the user who created the project. Pass through unchanged.

string

Access model for the engagement (for example, authenticated or unauthenticated).

string

Geographic or network location context.

string

Person or team responsible for the project.

string

ISO 8601 date-time by which the final report is due.

string

ISO 8601 date-time when the retesting window closes.

string

ISO 8601 date-time when retesting begins.

string

Engagement type, such as pentest or bug-bounty.

string

Security vendor or testing firm assigned to the project.

boolean

Whether a retesting cycle is required after the initial engagement.

Response

Returns the updated project object.

Example

curl -X PUT https://api-admin.hackgate.io/api/projects \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "proj_abc123",
    "orgId": "org_xyz",
    "name": "Q3 Web Application Pentest",
    "description": "Full-scope penetration test of the customer portal.",
    "note": "Scoping call completed.",
    "launchDate": "2025-07-01T09:00:00Z",
    "endDate": "2025-07-14T17:00:00Z",
    "creationDate": "2025-06-15T12:00:00Z",
    "createdBy": "user_123",
    "accessType": "authenticated",
    "location": "US-East",
    "owner": "security@example.com",
    "reportDeadline": "2025-07-21T17:00:00Z",
    "retestingEnd": "2025-08-04T17:00:00Z",
    "retestingLaunch": "2025-07-28T09:00:00Z",
    "type": "pentest",
    "vendor": "AcmeSec",
    "isRetestNeeded": true
  }'

POST /api/projects/createProjectItem

POST https://api-admin.hackgate.io/api/projects/createProjectItem

Adds a new item (a site or target) to an existing project. Items represent the individual in-scope assets for an engagement.

Request

string

required

Bearer token. See Authentication.

string

required

Must be application/json.

Body parameters

string

required

Name of the item, typically matching the HackGATE site name or target URL.

string

required

The unique identifier of the project to attach this item to.

Response

Returns the newly created project item object.

string

Unique identifier for the item.

string

The organization that owns the item.

string

The project this item belongs to.

string

Name of the item.

string

ISO 8601 date-time when the item was created.

string

Identifier of the user who created the item.

string

Access model. null until updated.

string

Location context. null until updated.

string

Item type. null until updated.

Example

curl -X POST https://api-admin.hackgate.io/api/projects/createProjectItem \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "customer-portal",
    "projectId": "proj_abc123"
  }'

{
  "id": "item_456",
  "orgId": "org_xyz",
  "projectId": "proj_abc123",
  "name": "customer-portal",
  "creationDate": "2025-06-16T10:30:00Z",
  "createdBy": "user_123",
  "accessType": null,
  "location": null,
  "type": null
}

PUT /api/projects/updateProjectItem

PUT https://api-admin.hackgate.io/api/projects/updateProjectItem

Updates the metadata of an existing project item. Use this to set or change the item’s name, access model, location, and type.

Request

string

required

Bearer token. See Authentication.

string

required

Must be application/json.

Body parameters

string

required

The unique identifier of the item to update.

string

required

Updated name for the item.

string

Access model for this item (for example, authenticated or unauthenticated).

string

Geographic or network location for the item.

string

Item type (for example, web, api, or mobile).

Response

Returns the updated project item object.

Example

curl -X PUT https://api-admin.hackgate.io/api/projects/updateProjectItem \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "item_456",
    "name": "customer-portal",
    "accessType": "authenticated",
    "location": "US-East",
    "type": "web"
  }'

{
  "id": "item_456",
  "orgId": "org_xyz",
  "projectId": "proj_abc123",
  "name": "customer-portal",
  "creationDate": "2025-06-16T10:30:00Z",
  "createdBy": "user_123",
  "accessType": "authenticated",
  "location": "US-East",
  "type": "web"
}

POST /api/projects — create a security project

Traffic analytics API — requests, users, paths

Overview

Sites

Projects

Analytics

Account & Org

Account

Analytics

Billing

Organization

PIE

Projects

Sites

PUT /api/projects and project items — update records

PUT /api/projects

Request

Body parameters

Response

Example

POST /api/projects/createProjectItem

Request

Body parameters

Response

Example

PUT /api/projects/updateProjectItem

Request

Body parameters

Response

Example

​PUT /api/projects

​Request

​Body parameters

​Response

​Example

​POST /api/projects/createProjectItem

​Request

​Body parameters

​Response

​Example

​PUT /api/projects/updateProjectItem

​Request

​Body parameters

​Response

​Example

PUT /api/projects

Request

Body parameters

Response

Example

POST /api/projects/createProjectItem

Request

Body parameters

Response

Example

PUT /api/projects/updateProjectItem

Request

Body parameters

Response

Example