AutoBot SEO API Documentation
By placing a formatted xml file with site map on your website, you allow Search Engine crawlers (like Google) to find out what pages are present and which have recently changed, and to crawl your site accordingly.
Below are the endpoints for managing sitemaps. Learn how to integrate the API into your application.
Site onboarding
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Body Parameters:
- agent Track agent activity with FREE record keeping
Optional (e.g., "agent" = req.headers['user-agent']) - coreScale Manage required total router-core capacity
(e.g., "100 to 1000") default=100
You can increase cScale upto 1000 based on service pack
In our experience average domains require over 12 and are unlikely to reach 250 core routes - pageScale Set custom links distribution count/page
(e.g., "100 to 1000") default=1000
Remember pScale can not be changed later!
PUT
This endpoint provides domain onboarding interface.
Page Distribution | Bandwidth | Endpoints/Route | Core Capacity |
---|---|---|---|
pScale=100 | 1003 | 1000000 | cScale * 1000000 |
pScale=1000 | 10003 | 1000000000 | cScale * 1000000000 |
Use a Self-hosted MongoDB (e.g., "mongodb+srv://<your-mongo-db-url>")
We recommend companies to max-out unless its a specific case.
Get domain sitemap.xml
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- agent Track agent activity with FREE record keeping
Optional (e.g., "agent" = req.headers['user-agent'])
sitemapindex attach/detach sitemap-loc create/remove url-loc
Explore API List for
This endpoint provides method to request sitemap router-core file.
Get domain robots.txt
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- agent Track agent activity with FREE record keeping
Optional (e.g., "agent" = req.headers['user-agent'])
Manage User-agent access allow/disallow crawl navigation
Explore API List for
This endpoint provides method to request robots.txt file.
Explore integration
Sitemap
Education
Sitemap & Robots know-how
Autobot
Free Course
List Free Online Courses
Official
Certifications
List Official Certificates
Validate
Accreditation
Verify Certification Status
Get route
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- route *Specify which page url to load
(e.g., "<sitemap-id>.xml" for https://example.com/sitemaps/sitemap-<sitemap-id>.xml).
This endpoint provides requested child-data using sitemap parent link.
Create loc-url
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Route binder used for pages & links
(e.g., "users") for users/* route links. - endpoint *Send a unique route link
(e.g., "username1") for users/user1 route /:username link. - img Provide image for URL
(e.g., "https://cdn.example.com/assets/image.jpeg"). - aud Provide audio for URL
(e.g., "https://cdn.example.com/assets/audio.jpeg"). - vid Provide video for URL
(e.g., "https://cdn.example.com/assets/video.jpeg").
This endpoint provides method to create new link.
Remove url-loc
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Route binder used for pages & links
(e.g., "users") for users/* route links. - endpoint *Send a route link to remove
(e.g., "username1") for users/user1 route /:username link.
This endpoint provides a method to remove an existing link.
Attach sitemapindex
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Create a unique route binder for pages & links
(e.g., "users") for users/* route links.
This endpoint provides a method to attach index route.
Detach sitemapindex
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Route binder used for pages & links
(e.g., "users") for users/* route links.
This endpoint provides a method to detach index route.
Change Agent Policy
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- policy *Specify which policy as a string in JSON body object
(e.g., {"policy":"policy string here"}).
This endpoint allows you to flip robots.txt policy.
Site sync
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
This endpoint allows to maintain blank sitemap for redirect.
Presence add/remove alternatives
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Route binder used for pages & links
(e.g., "users") for users/* route links. - endpoint *Send a unique route link
(e.g., "user1") for users/user1 route /:user link. - type *pick a custom alternative
(e.g., type=custom). - sub *allows to set presence subdomain
(e.g., "us" for us.example.com). - path *allows to set presence route
(e.g., "bombay" for example.com/bombay). - code *allows to set presence language
(e.g., "en").
This endpoint allows to create alternative presence.
Magnify robots priorities at core
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
This endpoint allows to change link priorities.
Magnify robots priorities on link
Authorization:
- privateId *Specify privateId for site
(e.g., "Bearer example^com-SomeIdString").
Route Parameters:
- :region *Please check location table here
(e.g., "WEST_3|ARAB_1|EAST_3|NORD_6").
Body Parameters:
- index *Route binder used for pages & links
(e.g., "users") for users/* route links. - endpoint *Send a route link to remove
(e.g., "username1") for users/user1 route /:username link. - magnify *Send priority to be set from 0 to 1
(e.g., "0.8") default=0.6 priority.
This endpoint allows to change link priorities.