Get bucket policy

GET 
/backend/api/object-storage/storage/:id/policy

Host: https://core.ocplanet.cloud

Retrieve the access policy attached to a bucket. The policy is returned in the standard S3 bucket policy JSON format.

Request

Path Parameters

id uuidrequired

A UUID string identifying this Object Bucket.

Responses

200

Current S3-compatible bucket policy document.

application/json

Schema

Schema

Version stringrequired

Policy language version. The standard value is 2012-10-17.

Id string

Optional identifier of the policy document.

Statement object[]required
Array [
Sid string
Optional statement identifier.
Effect stringrequired
Possible values: [Allow, Deny]
Whether the statement allows or denies the listed actions.
Principal object
Who the statement applies to. Use "*" for everyone, or an object such as {"AWS": ["arn:aws:iam::...:user/foo"]}.
oneOf
MOD1
string
Action object required
S3 action or list of actions, e.g. s3:GetObject.
oneOf
MOD1
string
MOD2
Array [
string
]
Resource object required
Bucket or object ARN(s) the statement applies to.
oneOf
MOD1
string
MOD2
Array [
string
]
Condition object
Optional condition block (operator → key → value), as per the S3 policy spec.
property name* object
oneOf
]

Example (from schema)

{
  "Version": "2012-10-17",
  "Id": "string",
  "Statement": [
    {
      "Sid": "AllowPublicRead",
      "Effect": "Allow",
      "Principal": "*",
      "Action": "s3:GetObject",
      "Resource": "arn:aws:s3:::my-bucket/*",
      "Condition": {}
    }
  ]
}

Loading...