Review Environments

Assign a review environment from pool

post

Fetches an available environment from the specified pool and assigns it to a PR, issue, user, or custom identifier. If an active assignment already exists, it will be reused.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assignmentTypestring · enumRequired

Type of assignment for the review environment

Possible values:

assignmentIdstringRequired

Unique identifier for the assignment (e.g., "123" for PR number)

Pattern: ^[a-zA-Z0-9@._-]+$

repositoryIdentifierstringRequired

Repository identifier in format owner/repo or org/project/repo

Pattern: ^[a-zA-Z0-9_.-]+\/[a-zA-Z0-9_.-]+(\/[a-zA-Z0-9_.-]+)?$

poolTagstringOptional

Tag of the pool to fetch from. If not provided, resolved via branch/domain patterns

Pattern: ^[a-z0-9_-]+$

branchstringOptional

Git branch name for automatic pool resolution

domainsstring[]Optional

Domain names for automatic pool resolution (supports multiple domains)

domainstringOptional

Specific domain for multi-domain assignments

expirationHoursinteger · min: 1 · max: 720Optional

Hours before expiration (1-720). If not provided, uses pool default

isImmortalbooleanOptional

If true, the environment will never expire

Default: false

overridebooleanOptional

Force reassignment even if an environment is already assigned

Default: false

Responses

403

Forbidden - Requires role: owner, application

No content

default

Review environment successfully assigned

application/json

post

/sfp/api/review/environments/assign

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/assign HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "assignmentType": "pr",
  "assignmentId": "text",
  "repositoryIdentifier": "text",
  "poolTag": "text",
  "branch": "text",
  "domains": [
    "text"
  ],
  "domain": "text",
  "expirationHours": 1,
  "isImmortal": false,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "override": false
}

No content

Get review environment details

get

Retrieves the details of a specific review environment assignment

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

assignmentTypestring · enumRequired

Type of assignment

Possible values:

assignmentIdstringRequired

Assignment identifier

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

domainstringOptional

Specific domain for multi-domain assignments

Example: sales

Responses

403

Forbidden - Requires role: owner, member, application

No content

default

Review environment details retrieved

application/json

get

/sfp/api/review/environments/{assignmentType}/{assignmentId}

HTTPcURLJavaScriptPython

GET /sfp/api/review/environments/{assignmentType}/{assignmentId}?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Extend review environment expiration

post

Extends the expiration time of a review environment assignment. Can also be used to make an environment immortal or remove immortal status.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assignmentTypestring · enumRequired

Type of assignment for the review environment

Example: prPossible values:

assignmentIdstringRequired

Unique identifier for the assignment

Example: 123

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

extensionHoursnumber · min: 1 · max: 168Optional

Number of hours to extend the expiration by. If not provided, uses pool default.

Example: 24

isImmortalbooleanOptional

If true, makes the environment immortal (never expires). If false, removes immortal status.

Example: false

domainstringOptional

Specific domain to extend. If not provided, extends the default domain.

Example: sales

Responses

403

Forbidden - Requires role: owner, member, application

No content

default

Expiration extended successfully

application/json

post

/sfp/api/review/environments/extend

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/extend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "assignmentType": "pr",
  "assignmentId": "123",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "extensionHours": 24,
  "isImmortal": false,
  "domain": "sales"
}

No content

Unassign review environment

post

Releases a review environment assignment and optionally returns it to the pool

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assignmentTypestring · enumRequired

Type of assignment for the review environment

Example: prPossible values:

assignmentIdstringRequired

Unique identifier for the assignment

Example: 123

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

returnToPoolbooleanOptional

If true, returns the environment to the pool as available. If false, marks it as expired.

Default: trueExample: true

domainstringOptional

Specific domain to unassign. If not provided, unassigns all domains.

Example: sales

Responses

403

Forbidden - Requires role: owner, member, application

No content

default

Environment unassigned successfully

application/json

post

/sfp/api/review/environments/unassign

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/unassign HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "assignmentType": "pr",
  "assignmentId": "123",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "returnToPool": true,
  "domain": "sales"
}

No content

Transition environment between assignments

post

Moves a review environment from one assignment to another (e.g., from PR to issue)

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

fromAssignmentTypestring · enumRequired

Current assignment type

Example: prPossible values:

fromAssignmentIdstringRequired

Current assignment identifier

Example: 123

toAssignmentTypestring · enumRequired

New assignment type

Example: issuePossible values:

toAssignmentIdstringRequired

New assignment identifier

Example: 456

metadataobjectOptional

Additional metadata for the new assignment

Example: {"reason":"PR merged, moving to issue for tracking","transitionedBy":"automation"}

Responses

403

Forbidden - Requires role: owner, member

No content

default

Environment transitioned successfully

application/json

post

/sfp/api/review/environments/transition

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/transition HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "fromAssignmentType": "pr",
  "fromAssignmentId": "123",
  "toAssignmentType": "issue",
  "toAssignmentId": "456",
  "metadata": {
    "reason": "PR merged, moving to issue for tracking",
    "transitionedBy": "automation"
  }
}

No content

Acquire environment for use

post

Marks an assigned environment as in-use for a specified duration. Uses optimistic locking to handle concurrent requests.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assignmentTypestring · enumRequired

Type of assignment

Example: prPossible values:

assignmentIdstringRequired

Unique identifier for the assignment

Example: 123

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

durationnumber · min: 1 · max: 480Required

Duration in minutes for which the environment is needed

Example: 30

usedBystringRequired

Identifier of the process or user acquiring the environment

Example: ci-pipeline-123 or [email protected]

domainstringOptional

Specific domain to acquire (for multi-domain assignments)

Example: sales

Responses

200

Environment successfully acquired

application/json

403

Forbidden - Requires role: owner, member, application

No content

404

Review environment assignment not found

409

Environment is currently in use or was acquired by another process

application/json

post

/sfp/api/review/environments/acquire

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/acquire HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "assignmentType": "pr",
  "assignmentId": "123",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "duration": 30,
  "usedBy": "ci-pipeline-123 or [email protected]",
  "domain": "sales"
}

{
  "status": "environment_acquired",
  "message": "Environment successfully acquired for 30 minutes",
  "timestamp": "2026-02-10T10:06:59.063Z",
  "assignment": null
}

Release environment from use

post

Marks an environment as idle, making it available for other processes to acquire

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

assignmentTypestring · enumRequired

Type of assignment

Possible values:

assignmentIdstring · min: 1Required

Unique identifier for the assignment

repositoryIdentifierstringRequired

Repository identifier in format owner/repo or org/project/repo

Pattern: ^[a-zA-Z0-9_.-]+\/[a-zA-Z0-9_.-]+(\/[a-zA-Z0-9_.-]+)?$

domainstringOptional

Specific domain to release (for multi-domain assignments)

Responses

200

Environment successfully released

application/json

403

Forbidden - Requires role: owner, member, application

No content

404

Review environment assignment not found

409

Environment state was modified by another process

post

/sfp/api/review/environments/release

HTTPcURLJavaScriptPython

POST /sfp/api/review/environments/release HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "assignmentType": "pr",
  "assignmentId": "text",
  "repositoryIdentifier": "text",
  "domain": "text"
}

{
  "status": "environment_released",
  "message": "Environment successfully released",
  "timestamp": "2026-02-10T10:06:59.063Z",
  "assignment": null
}

List review environment assignments

get

Retrieves a list of review environment assignments with optional filters

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringOptional

Filter by repository identifier

Example: flxbl-io/sf-core

assignmentTypestring · enumOptional

Filter by assignment type

Possible values:

assignmentIdstringOptional

Filter by assignment ID

Example: 123

poolTagstringOptional

Filter by pool tag

Example: core_dev

statusstring · enumOptional

Filter by assignment status

Possible values:

assignedBystringOptional

Filter by who assigned the environment

Example: [email protected]

includeExpiredbooleanOptional

Include expired assignments in the results. By default, expired assignments are excluded unless explicitly requested

Default: falseExample: false

Responses

403

Forbidden - Requires role: owner, member, application

No content

default

List of review environment assignments

application/json

get

/sfp/api/review/environments/list

HTTPcURLJavaScriptPython

GET /sfp/api/review/environments/list HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content