Files API

5 operations from the external ASIRI OpenAPI surface.

Public endpoint

GET`/v1/files`

List tenant files visible to the caller

Requiresfiles:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`module`	query	no	`string`	-
`resourceId`	query	no	`string`	-
`cursor`	query	no	`string`	-
`limit`	query	no	`integer`	-

Request body

No request body.

Responses

GET/v1/filesPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/files' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "items": [
      {
        "id": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
        "module": "string",
        "resourceId": "string",
        "filename": "string",
        "contentType": "string",
        "sizeBytes": 1
      }
    ],
    "nextCursor": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee"
  }
}

Public endpoint

GET`/v1/files/{id}`

Fetch file metadata (with download URL when scan is clean)

Requiresfiles:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

GET/v1/files/{id}Public schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/files/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

DELETE`/v1/files/{id}`

Soft-delete a file and schedule the S3 purge

Requiresfiles:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

DELE/v1/files/{id}Public schema

curl --request DELETE \
  --url 'https://api.asiri.ng/v1/files/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

POST`/v1/files/{id}/complete`

Mark a presigned upload as complete and enqueue the virus scan

Requiresfiles:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

application/jsonobject

Responses

POST/v1/files/{id}/completePublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/files/{id}/complete' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "etag": "string"
}'

Example response200

application/json

{}

Public endpoint

POST`/v1/files/presign`

Presign an S3 upload URL for a new file

Requiresfiles:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

application/jsonobject

Responses

POST/v1/files/presignPublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/files/presign' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filename": "string",
  "mime": "string",
  "byteSize": 1,
  "module": "dsr",
  "purpose": "string",
  "resourceId": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee"
}'

Example response201

application/json

{}

Files API

GET/v1/files

Security

Parameters

Request body

Responses

GET/v1/files/{id}

Security

Parameters

Request body

Responses

DELETE/v1/files/{id}

Security

Parameters

Request body

Responses

POST/v1/files/{id}/complete

Security

Parameters

Request body

Responses

POST/v1/files/presign

Security

Parameters

Request body

Responses

GET`/v1/files`

GET`/v1/files/{id}`

DELETE`/v1/files/{id}`

POST`/v1/files/{id}/complete`

POST`/v1/files/presign`