Menu

Referência da API · Indexação

Sitemaps

seo_indexation · sitemaps · 3 operações

GET/v1/seo/indexation/sitemaps

List the sitemaps of a Search Console property

seo_indexation.sitemaps.list

LeituraIdempotenteDesde 2026-11-01

Lists the sitemaps submitted to a Search Console property connected to the organization (site_url from seo_indexation.properties.list), live from Google: for each one its path (the sitemap URL), last_submitted and last_downloaded (ISO dates), is_pending (Google has not processed it yet), warnings, errors and contents (type, submitted URLs; indexed is deprecated by Google and usually 0). Not paginated. Errors: 404 external_account_not_linked (that site_url is not connected to this organization; Google is not called), 409 integration_not_connected (no Search Console connection: connect it in Integrations), 409 integration_reconnect_required (details.reason: expired, the connection expired or was revoked; missing_permission, it lacks a permission; access_lost, the connected Google account lost access to the property), 429 external_rate_limited, 503 external_unavailable. Spends Google quota. Requires view access to Indexation.

Escopo
seo_indexation:read
Permissão
Ver o módulo
Tool do MCP
seo_indexation_sitemaps_listNa superfície completa; na compacta, mb_execute_operation com id: "seo_indexation.sitemaps.list".

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária). Usa uma plataforma externa (google): conta na cota de operações externas.

Parâmetros

site_urlstringqueryobrigatório

The Search Console property, as seo_indexation.properties.list returns it: a URL-prefix property (https://www.example.com/) or a domain property (sc-domain:example.com). It must be connected to the organization in Data Sources; a trailing slash or the host's letter case may differ.

Resposta

site_urlstring
dataarray<object>
has_morefalse

Always false: every sitemap of the property comes in one answer.

Erros

Exemplo

curl "https://api.mb-suite.com/v1/seo/indexation/sitemaps?site_url=SITE_URL" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

POST/v1/seo/indexation/sitemaps

Submit a sitemap to a Search Console property

seo_indexation.sitemaps.submit

EscritaDesde 2026-11-01

Submits (or resubmits) a sitemap to a Search Console property connected to the organization: site_url from seo_indexation.properties.list and feedpath, the full http(s) URL of the sitemap file (e.g. https://www.example.com/sitemap.xml). Google fetches and processes it afterwards; its status shows later in seo_indexation.sitemaps.list (is_pending, errors, warnings). Submitting one that is already there asks Google to read it again. Changes the property in Google Search Console, not in MB Suite. Errors: 404 external_account_not_linked (Google is not called), 409 external_rejected (Google rejected the sitemap: it must be reachable, be valid XML and live inside the property), 409 integration_not_connected, 409 integration_reconnect_required, 429 external_rate_limited, 503 external_unavailable. Spends Google quota. Requires edit access to Indexation.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
seo_indexation:write
Permissão
Editar no módulo
Tool do MCP
seo_indexation_sitemaps_submitNa superfície completa; na compacta, mb_execute_operation com id: "seo_indexation.sitemaps.submit".
Eventos que pode emitir
seo_indexation.sitemap.submitted

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária). Usa uma plataforma externa (google): conta na cota de operações externas.

Parâmetros

site_urlstringcorpoobrigatório

The Search Console property, as seo_indexation.properties.list returns it: a URL-prefix property (https://www.example.com/) or a domain property (sc-domain:example.com). It must be connected to the organization in Data Sources; a trailing slash or the host's letter case may differ.

feedpathstringcorpoobrigatório

The full URL of the sitemap file, e.g. https://www.example.com/sitemap.xml (the path of a sitemap in seo_indexation.sitemaps.list).

Resposta

oktrue
site_urlstring
pathstring

Erros

Exemplo

curl -X POST "https://api.mb-suite.com/v1/seo/indexation/sitemaps" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "site_url": "SITE_URL",
  "feedpath": "FEEDPATH",
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.

DELETE/v1/seo/indexation/sitemaps

Remove a sitemap from a Search Console property

seo_indexation.sitemaps.delete

IrreversívelDesde 2026-11-01

Removes a submitted sitemap from a Search Console property connected to the organization: site_url and feedpath (the sitemap's path in seo_indexation.sitemaps.list; over REST both go in the JSON body of the DELETE, since they are URLs). Google stops reading that sitemap; the file on the site is untouched and it can be submitted again with seo_indexation.sitemaps.submit. Nothing goes to MB Suite's trash (the sitemap lives in Google). Outside the screen it always requires a dry run first (dry_run: true reads the property's sitemaps and describes the one to remove, 404 sitemap_not_found if it is not submitted) and then the same body with its confirm_token. Errors: 404 external_account_not_linked, 404 sitemap_not_found, 409 external_rejected, 409 integration_not_connected, 409 integration_reconnect_required, 429 external_rate_limited, 503 external_unavailable. Spends Google quota. Requires edit access to Indexation and, for a credential, deletion enabled.

Pede confirmação: primeiro dry_run: true (prévia e confirm_token, válido por 10 minutos e por uma única execução), depois o mesmo corpo com confirm_token. Em algumas poucas, só com certos dados: a descrição diz quando. Por que e como: Prévia e confirmação.

Escopo
seo_indexation:write e «Permitir exclusões» (seo_indexation:delete no OAuth)
Permissão
Editar no módulo
Tool do MCP
seo_indexation_sitemaps_deleteNa superfície completa; na compacta, mb_execute_operation com id: "seo_indexation.sitemaps.delete".
Eventos que pode emitir
seo_indexation.sitemap.deleted

Custo declarado: até 2 leituras e 0 escritas por chamada (contam na cota diária). Usa uma plataforma externa (google): conta na cota de operações externas.

Parâmetros

site_urlstringcorpoobrigatório

The Search Console property, as seo_indexation.properties.list returns it: a URL-prefix property (https://www.example.com/) or a domain property (sc-domain:example.com). It must be connected to the organization in Data Sources; a trailing slash or the host's letter case may differ.

feedpathstringcorpoobrigatório

The full URL of the sitemap file, e.g. https://www.example.com/sitemap.xml (the path of a sitemap in seo_indexation.sitemaps.list).

Resposta

oktrue
site_urlstring
pathstring

Erros

Exemplo

curl -X DELETE "https://api.mb-suite.com/v1/seo/indexation/sitemaps" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "site_url": "SITE_URL",
  "feedpath": "FEEDPATH",
  "dry_run": true
}'

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar. Na prática esta operação não é simulada (usa outra plataforma): responde 409 sandbox_external_unavailable.