Create Share Request

posthttps://app.fossa.com/api/v1/share-requests

Create a new share request for an SBOM revision. This endpoint queues a job to process the share request and returns a task reference.

Request body (required) · application/json

revisionIdstringrequired

The locator for the revision to share

sharedOrganizationIdinteger <int64>required

The ID of the shared organization record

Responses

201The share request was created successfully and a job was queued to process it.
taskobject
namestring

Identifier for the task type (e.g., "ProjectRevisionShare")

jobTokenstring

Token used to track the share job

400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404Not Found
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

500Server Error
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

POST https://app.fossa.com/api/v1/share-requests
curl --request POST \  --url 'https://app.fossa.com/api/v1/share-requests' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "revisionId": "string",  "sharedOrganizationId": 1}'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.
application/json