searchconsole.sitemaps.get
Retrieves details for a specific sitemap in a Search Console site by site URL and sitemap URL, returning the sitemap metadata as JSON.
Instructions
Retrieves information about a specific sitemap [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, list, submit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| siteUrl | Yes | [URL path segment] The site's URL, including protocol. For example: `http://www.example.com/`. | |
| feedpath | Yes | [URL path segment] The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | ||
| type | No | ||
| errors | No | ||
| contents | No | ||
| warnings | No | ||
| isPending | No | ||
| lastSubmitted | No | ||
| lastDownloaded | No | ||
| isSitemapsIndex | No |