{ "opencollection": "1.0.0", "info": { "name": "Google Cloud Storage JSON BucketAccessControls Buckets API", "version": "v1" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Buckets", "type": "folder" }, "items": [ { "info": { "name": "Google Cloud Storage List Buckets", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b", "params": [ { "name": "project", "value": "my-project-id", "type": "query", "description": "The project ID or project number to list buckets for." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of buckets to return in a single response. The service uses this value or 1,000 items, whichever is smaller." }, { "name": "pageToken", "value": "", "type": "query", "description": "A previously-returned page token representing part of the larger set of results to view. The pageToken is an encoded field that marks the name and generation of the last bucket in the previous list response." }, { "name": "prefix", "value": "", "type": "query", "description": "Filter results to buckets whose names begin with this prefix." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying a subset of fields to include in the response. Use for better performance by retrieving only needed fields." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks. Default is true. When set to false, can reduce the response payload size." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Retrieves a list of buckets for a given project. The authenticated user must have the storage.buckets.list permission for the specified project." }, { "info": { "name": "Google Cloud Storage Create a Bucket", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b", "params": [ { "name": "project", "value": "my-project-id", "type": "query", "description": "The project ID or project number to create the bucket in." }, { "name": "predefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the bucket." }, { "name": "predefinedDefaultObjectAcl", "value": "", "type": "query", "description": "Apply a predefined set of default object access controls to the bucket." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "enableObjectRetention", "value": "", "type": "query", "description": "When set to true, object retention is enabled for this bucket." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying a subset of fields to include in the response. Use for better performance by retrieving only needed fields." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks. Default is true. When set to false, can reduce the response payload size." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new bucket in the specified project. The authenticated user must have the storage.buckets.create permission for the project. Bucket names must be globally unique across all of Cloud Storage." }, { "info": { "name": "Google Cloud Storage Get a Bucket", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying a subset of fields to include in the response. Use for better performance by retrieving only needed fields." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks. Default is true. When set to false, can reduce the response payload size." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Returns metadata for the specified bucket. The authenticated user must have the storage.buckets.get permission for the bucket." }, { "info": { "name": "Google Cloud Storage Update a Bucket", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the update conditional on whether the bucket's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the update conditional on whether the bucket's current metageneration does not match the given value." }, { "name": "predefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the bucket." }, { "name": "predefinedDefaultObjectAcl", "value": "", "type": "query", "description": "Apply a predefined set of default object access controls." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to full." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying a subset of fields to include in the response. Use for better performance by retrieving only needed fields." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks. Default is true. When set to false, can reduce the response payload size." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method replaces all mutable properties of the bucket with the values in the request body." }, { "info": { "name": "Google Cloud Storage Patch a Bucket", "type": "http" }, "http": { "method": "PATCH", "url": "https://storage.googleapis.com/storage/v1/b/:bucket", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the patch conditional on whether the bucket's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the patch conditional on whether the bucket's current metageneration does not match the given value." }, { "name": "predefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the bucket." }, { "name": "predefinedDefaultObjectAcl", "value": "", "type": "query", "description": "Apply a predefined set of default object access controls." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to full." }, { "name": "fields", "value": "", "type": "query", "description": "Selector specifying a subset of fields to include in the response. Use for better performance by retrieving only needed fields." }, { "name": "prettyPrint", "value": "", "type": "query", "description": "Returns response with indentations and line breaks. Default is true. When set to false, can reduce the response payload size." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics where only the specified fields are updated." }, { "info": { "name": "Google Cloud Storage Delete a Bucket", "type": "http" }, "http": { "method": "DELETE", "url": "https://storage.googleapis.com/storage/v1/b/:bucket", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the deletion conditional on whether the bucket's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the deletion conditional on whether the bucket's current metageneration does not match the given value." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Permanently deletes an empty bucket. The authenticated user must have the storage.buckets.delete permission for the bucket. The bucket must be empty before it can be deleted." }, { "info": { "name": "Google Cloud Storage Lock Retention Policy", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/lockRetentionPolicy", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the bucket's current metageneration matches the given value." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Locks retention policy on a bucket. This action is irreversible. Once locked, the retention policy cannot be removed or the retention period shortened." }, { "info": { "name": "Google Cloud Storage Get Bucket Iam Policy", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/iam", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "optionsRequestedPolicyVersion", "value": "", "type": "query", "description": "The IAM policy format version to be returned. Valid values are 1 and 3. Requests specifying an invalid value will be rejected. Defaults to 1." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Returns an IAM policy for the specified bucket. The authenticated user must have the storage.buckets.getIamPolicy permission." }, { "info": { "name": "Google Cloud Storage Set Bucket Iam Policy", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/iam", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IAM policy for the specified bucket. The authenticated user must have the storage.buckets.setIamPolicy permission." }, { "info": { "name": "Google Cloud Storage Test Bucket Iam Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/iam/testPermissions", "params": [ { "name": "bucket", "value": "my-bucket", "type": "path", "description": "Name of the bucket. Bucket names must be globally unique and comply with naming requirements." }, { "name": "permissions", "value": "storage.buckets.get,storage.objects.list", "type": "query", "description": "Permissions to test." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Tests a set of permissions on the given bucket to see which, if any, are held by the caller. The authenticated user must have the storage.buckets.testIamPermissions permission." } ] } ], "bundled": true }