Security Incident Response
This guide documents the action and response elements for use of the service.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This guide documents the action and response elements for use of the service.
Endpoints 25
Membership
- POSTBatch get member account details
/v1/membership/:membershipId/batch-member-detailsProvides information on whether the supplied account IDs are associated with a membership. AWS account ID's may appear less than 12 characters and need to be… - GETGet membership
/v1/membership/:membershipIdReturns the attributes of a membership. - PUTCancel membership
/v1/membership/:membershipIdCancels an existing membership. - POSTCreate membership
/v1/membershipCreates a new membership. - GETGet finding metrics
/v1/membership/:membershipId/finding-metrics?startDate=string&endDate=stringReturns finding-lifecycle metrics for a membership over a date range. - POSTList memberships
/v1/membershipsReturns the memberships that the calling principal can access. - PUTUpdate membership
/v1/membership/:membershipId/update-membershipUpdates membership configuration.
Case
- POSTClose case
/v1/cases/:caseId/close-caseCloses an existing case. - POSTCreate case
/v1/create-caseCreates a new case. - POSTCreate case comment
/v1/cases/:caseId/create-commentAdds a comment to an existing case. - GETGet case
/v1/cases/:caseId/get-caseReturns the attributes of a case. - GETGet case attachment download url
/v1/cases/:caseId/get-presigned-url/:attachmentIdReturns a Pre-Signed URL for uploading attachments into a case. - POSTGet case attachment upload url
/v1/cases/:caseId/get-presigned-urlUploads an attachment to a case. - POSTList case edits
/v1/cases/:caseId/list-case-editsViews the case history for edits made to a designated case. - POSTList cases
/v1/list-casesLists all cases the requester has access to. - POSTList comments
/v1/cases/:caseId/list-commentsReturns comments for a designated case. - GETList investigations
/v1/cases/:caseId/list-investigations?nextToken=string&maxResults=0Investigation performed by an agent for a security incident... - POSTSend feedback
/v1/cases/:caseId/feedback/:resultId/send-feedbackSend feedback based on response investigation action - POSTUpdate case
/v1/cases/:caseId/update-caseUpdates an existing case. - PUTUpdate case comment
/v1/cases/:caseId/update-case-comment/:commentIdUpdates an existing case comment. - POSTUpdate case status
/v1/cases/:caseId/update-case-statusUpdates the state transitions for a designated cases. Self-managed : the following states are available for self-managed cases. Submitted → Detection and… - POSTUpdate resolver type
/v1/cases/:caseId/update-resolver-typeUpdates the resolver type for a case. This is a one-way action and cannot be reversed.
- GETList tags for resource
/v1/tags/:resourceArnReturns currently configured tags on a resource. - POSTTag resource
/v1/tags/:resourceArnAdds a tag(s) to a designated resource. - DELETEUntag resource
/v1/tags/:resourceArn?tagKeys=Removes a tag(s) from a designate resource.
API details
- Base URL
https://security-ir.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 25 operations on 22 pathsPOST 15GET 6PUT 3DELETE 1
- Main resources
- Case 15Membership 7
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Security Incident Response in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Security Incident Response collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch get member account details” (POST /v1/membership/:membershipId/batch-member-details), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Security Incident Response?
This guide documents the action and response elements for use of the service. It is listed under Identity & security and has 25 endpoints.
Who publishes the Security Incident Response?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Security Incident Response?
Requests go to https://security-ir.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Security Incident Response?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Security Incident Response have?
25 operations on 22 paths (15 POST, 6 GET, 3 PUT, 1 DELETE). The largest groups are Case, Membership.
Is forking the Security Incident Response free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.