{ "opencollection": "1.0.0", "info": { "name": "Google Cloud Storage JSON 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." } ] }, { "info": { "name": "Objects", "type": "folder" }, "items": [ { "info": { "name": "Google Cloud Storage List Objects", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o", "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": "delimiter", "value": "/", "type": "query", "description": "Returns results in a directory-like mode. Items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted." }, { "name": "endOffset", "value": "", "type": "query", "description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed have names between startOffset (inclusive) and endOffset (exclusive)." }, { "name": "includeFoldersAsPrefixes", "value": "", "type": "query", "description": "Only applicable if delimiter is set to /. If true, will also include folders and managed folders (besides objects) in the returned prefixes." }, { "name": "includeTrailingDelimiter", "value": "", "type": "query", "description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes." }, { "name": "matchGlob", "value": "", "type": "query", "description": "Filter results to objects and prefixes that match this glob pattern. Supports *, **, ?, and [...] character classes." }, { "name": "maxResults", "value": "", "type": "query", "description": "Maximum number of items plus prefixes to return in a single page of responses. The service may return fewer than this value." }, { "name": "pageToken", "value": "", "type": "query", "description": "A previously-returned page token representing part of the larger set of results to view." }, { "name": "prefix", "value": "", "type": "query", "description": "Filter results to objects whose names begin with this prefix." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "softDeleted", "value": "", "type": "query", "description": "If true, only lists soft-deleted object versions." }, { "name": "startOffset", "value": "", "type": "query", "description": "Filter results to objects whose names are lexicographically equal to or after startOffset." }, { "name": "versions", "value": "", "type": "query", "description": "If true, lists all versions of an object as distinct results. The default is false." }, { "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 objects matching the criteria. The authenticated user must have the storage.objects.list permission for the bucket. Lists objects in a bucket, optionally filtering by a prefix and delimiter to emulate directory listing." }, { "info": { "name": "Google Cloud Storage Get an Object", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "alt", "value": "", "type": "query", "description": "Data format for the response. Use json for metadata or media to download the object data." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "softDeleted", "value": "", "type": "query", "description": "If true, retrieves the soft-deleted version of the object." }, { "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 an object or its metadata. The authenticated user must have the storage.objects.get permission for the object. By default, this returns the object metadata. Use alt=media to download the object data." }, { "info": { "name": "Google Cloud Storage Update an Object", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation matches the given value." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value." }, { "name": "predefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the object." }, { "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 an object's metadata. This method replaces all mutable metadata fields of the object with the values in the request body." }, { "info": { "name": "Google Cloud Storage Patch an Object", "type": "http" }, "http": { "method": "PATCH", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation matches the given value." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration does not match the given value." }, { "name": "predefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the object." }, { "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 an object's metadata. This method supports patch semantics where only the specified fields are updated." }, { "info": { "name": "Google Cloud Storage Delete an Object", "type": "http" }, "http": { "method": "DELETE", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "generation", "value": "", "type": "query", "description": "If present, permanently deletes a specific revision of this object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation matches the given value." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the object'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": "Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the object is not the latest version. When versioning is enabled, deleting the latest version creates a delete marker." }, { "info": { "name": "Google Cloud Storage Compose Objects", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/compose", "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": "object", "value": "", "type": "path", "description": "Name of the destination object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current generation matches the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object'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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Concatenates a list of existing objects into a new object in the same bucket. The composed object can contain no more than 32 source objects. The destination object's metadata is identical to that of the first source object unless overridden." }, { "info": { "name": "Google Cloud Storage Copy an Object", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/copyTo/b/:destinationBucket/o/:destinationObject", "params": [ { "name": "bucket", "value": "", "type": "path", "description": "Name of the source bucket." }, { "name": "object", "value": "", "type": "path", "description": "Name of the source object. For information about how to URL-encode object names, see Encoding URI path parts." }, { "name": "destinationBucket", "value": "", "type": "path", "description": "Name of the destination bucket." }, { "name": "destinationObject", "value": "", "type": "path", "description": "Name of the destination object." }, { "name": "destinationPredefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the destination object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current generation matches the given value." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value." }, { "name": "ifSourceGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current generation matches the given value." }, { "name": "ifSourceGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current generation does not match the given value." }, { "name": "ifSourceMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value." }, { "name": "ifSourceMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "sourceGeneration", "value": "", "type": "query", "description": "If present, selects a specific revision of the source object." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copies a source object to a destination object. Optionally overrides metadata. This method creates a copy of an object as a new object in the destination bucket." }, { "info": { "name": "Google Cloud Storage Rewrite an Object", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/rewriteTo/b/:destinationBucket/o/:destinationObject", "params": [ { "name": "bucket", "value": "", "type": "path", "description": "Name of the source bucket." }, { "name": "object", "value": "", "type": "path", "description": "Name of the source object." }, { "name": "destinationBucket", "value": "", "type": "path", "description": "Name of the destination bucket." }, { "name": "destinationObject", "value": "", "type": "path", "description": "Name of the destination object." }, { "name": "destinationKmsKeyName", "value": "", "type": "query", "description": "Resource name of the Cloud KMS key that will be used to encrypt the destination object." }, { "name": "destinationPredefinedAcl", "value": "", "type": "query", "description": "Apply a predefined set of access controls to the destination object." }, { "name": "ifGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current generation matches the given value." }, { "name": "ifGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current generation does not match the given value." }, { "name": "ifMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value." }, { "name": "ifSourceGenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current generation matches the given value." }, { "name": "ifSourceGenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current generation does not match the given value." }, { "name": "ifSourceMetagenerationMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current metageneration matches the given value." }, { "name": "ifSourceMetagenerationNotMatch", "value": "", "type": "query", "description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value." }, { "name": "maxBytesRewrittenPerCall", "value": "", "type": "query", "description": "The maximum number of bytes that will be rewritten per rewrite request. Allows throttling of large copies." }, { "name": "projection", "value": "", "type": "query", "description": "Set of properties to return. Defaults to noAcl." }, { "name": "rewriteToken", "value": "", "type": "query", "description": "Include this field only if the previous rewrite response included a rewriteToken. Provides a token for resuming a previously started rewrite operation." }, { "name": "sourceGeneration", "value": "", "type": "query", "description": "If present, selects a specific revision of the source object." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rewrites a source object to a destination object. Optionally overrides metadata. This method can copy objects across locations and storage classes, and can also be used to change an object's encryption key. For large objects, this method may require multiple calls." }, { "info": { "name": "Google Cloud Storage Watch for Object Changes", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/watchAll", "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": "prefix", "value": "", "type": "query", "description": "Limits notifications to objects with names beginning with this prefix." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Watch for changes on all objects in a bucket. This method creates a notification channel that sends a notification whenever an object is created, updated, or deleted." }, { "info": { "name": "Google Cloud Storage Stop a Notification Channel", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/channels/stop", "body": { "type": "json", "data": "{}" } }, "docs": "Stop receiving object change notifications through a previously created watch channel." } ] }, { "info": { "name": "BucketAccessControls", "type": "folder" }, "items": [ { "info": { "name": "Google Cloud Storage List Bucket Acl Entries", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl", "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." } ] }, "docs": "Retrieves ACL entries on the specified bucket. The authenticated user must have the storage.buckets.getIamPolicy permission." }, { "info": { "name": "Google Cloud Storage Create a Bucket Acl Entry", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl", "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": "Creates a new ACL entry on the specified bucket. The authenticated user must have the storage.buckets.setIamPolicy permission." }, { "info": { "name": "Google Cloud Storage Get a Bucket Acl Entry", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Returns the ACL entry for the specified entity on the specified bucket." }, { "info": { "name": "Google Cloud Storage Update a Bucket Acl Entry", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "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 ACL entry on the specified bucket." }, { "info": { "name": "Google Cloud Storage Patch a Bucket Acl Entry", "type": "http" }, "http": { "method": "PATCH", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "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 an ACL entry on the specified bucket." }, { "info": { "name": "Google Cloud Storage Delete a Bucket Acl Entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/acl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Permanently deletes the ACL entry for the specified entity on the specified bucket." } ] }, { "info": { "name": "DefaultObjectAccessControls", "type": "folder" }, "items": [ { "info": { "name": "Google Cloud Storage List Default Object Acl Entries", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl", "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": "If present, only returns the default ACL listing if the bucket's current metageneration matches this value." }, { "name": "ifMetagenerationNotMatch", "value": "", "type": "query", "description": "If present, only returns the default ACL listing if the bucket's current metageneration does not match this value." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Retrieves default object ACL entries on the specified bucket. These are applied to new objects when no ACL is provided." }, { "info": { "name": "Google Cloud Storage Create a Default Object Acl Entry", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl", "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": "Creates a new default object ACL entry on the specified bucket." }, { "info": { "name": "Google Cloud Storage Get a Default Object Acl Entry", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Returns the default object ACL entry for the specified entity on the specified bucket." }, { "info": { "name": "Google Cloud Storage Update a Default Object Acl Entry", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "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 default object ACL entry on the specified bucket." }, { "info": { "name": "Google Cloud Storage Patch a Default Object Acl Entry", "type": "http" }, "http": { "method": "PATCH", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "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 default object ACL entry on the specified bucket." }, { "info": { "name": "Google Cloud Storage Delete a Default Object Acl Entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/defaultObjectAcl/:entity", "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": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Permanently deletes the default object ACL entry for the specified entity on the specified bucket." } ] }, { "info": { "name": "ObjectAccessControls", "type": "folder" }, "items": [ { "info": { "name": "Google Cloud Storage List Object Acl Entries", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Retrieves ACL entries on the specified object." }, { "info": { "name": "Google Cloud Storage Create an Object Acl Entry", "type": "http" }, "http": { "method": "POST", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "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 ACL entry on the specified object." }, { "info": { "name": "Google Cloud Storage Get an Object Acl Entry", "type": "http" }, "http": { "method": "GET", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl/:entity", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Returns the ACL entry for the specified entity on the specified object." }, { "info": { "name": "Google Cloud Storage Update an Object Acl Entry", "type": "http" }, "http": { "method": "PUT", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl/:entity", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "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 ACL entry on the specified object." }, { "info": { "name": "Google Cloud Storage Patch an Object Acl Entry", "type": "http" }, "http": { "method": "PATCH", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl/:entity", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "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 an ACL entry on the specified object." }, { "info": { "name": "Google Cloud Storage Delete an Object Acl Entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://storage.googleapis.com/storage/v1/b/:bucket/o/:object/acl/:entity", "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": "object", "value": "my-object.txt", "type": "path", "description": "Name of the object. For information about how to URL-encode object names to be path safe, see Encoding URI path parts." }, { "name": "entity", "value": "user-example@gmail.com", "type": "path", "description": "The entity holding the permission, in one of the following forms: user-userId, user-email, group-groupId, group-email, domain-domain, project-team-projectId, allUsers, or allAuthenticatedUsers." }, { "name": "generation", "value": "", "type": "query", "description": "If present, selects a specific revision of this object." }, { "name": "userProject", "value": "", "type": "query", "description": "The project to be billed for this request. Required for Requester Pays buckets." } ] }, "docs": "Permanently deletes the ACL entry for the specified entity on the specified object." } ] } ], "bundled": true }