Space S3 Documents REST API

 

Get Space S3 Documents

GET http://localhost:8080/rest/spaces3documents/1.0/utility/list/documents

Query Parameters:

  • spaceKey (String) or spaceId (Number) - (Required)

  • documentId (Number) - Optional

  • search (String) - Optional

Response: [Status: 200]

1 2 $ curl -u"user:password" -XGET http://localhost:8080/rest/spaces3documents/1.0/utility/list \ /documents/?spaceKey=SWTEST

 

Attach existing Amazon S3 Document

POST http://localhost:8080/rest/spaces3documents/1.0/utility/attach/documents

Required Schema Fields:

  • spaceKey (String) - Confluence Space Key

  • documentKey (String) - AWS S3 Document Path

Response: [Status: 200]

1 2 3 4 5 6 $ curl -u"user:password" -XPOST \ http://localhost:8080/rest/spaces3documents/1.0/utility/attach/documents \ -H "Content-Type: application/json" --data '{"spaceKey":"SWTEST","documentKey": \ "test2/README"}' {"status":17,"message":"[Info] Space S3 Document has been attached."} $

 

Detach Amazon S3 Document on Jira

DELETE http://localhost:8080/rest/spaces3documents/1.0/utility/detach/document

Query Parameters:

  • spaceKey (String) or spaceId (Number) - (Required)

  • documentId (Number) - Optional

1 2 3 4 $ curl -u"user:password" -XDELETE \ "http://localhost:8080/rest/spaces3documents/1.0/utility/detach/document/?spaceKey=SWTEST&documentId=17" {"status":17,"message":"[Info] S3 Document has been detached."} $