> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetRobotsTxt

# Package: txtFileServer

# Namespace: RobotsServiceV2

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/seo/txt-file-server/robots-txt/get-robots-txt.md

## Permission Scopes:
View SEO Settings: SCOPE.PROMOTE.VIEW-SEO

## Introduction

Retrieves the `robots.txt` file entity.

---

## REST API

### Schema

```
 Method: getRobotsTxt
 Description: Retrieves the `robots.txt` file entity.
 URL: https://www.wixapis.com/promote-seo-robots-server/v2/robots
 Method: GET
 Method parameters:
   query param name: subdomain | type: subdomain | description: Subdomain of the requested `robots.txt file`. For example, `www`, `es`, `fr`. Default: `www`. 
 Return type: GetRobotsTxtResponse
  - name: robotsTxt | type: RobotsTxt | description: Retrieved `robots.txt` file entity. 
     - name: content | type: string | description: Full text content of the `robots.txt` file. 
     - name: default | type: boolean | description: Whether this `robots.txt` file uses Wix's [default content](https://support.wix.com/en/article/editing-your-sites-robotstxt-file). 
     - name: subdomain | type: string | description: If applicable, target subdomain for the `robots.txt` file. For example, a site can have multiple subdomains like `www.example.com`, `es.example.com`, `fr.example.com`. Each subdomain can have its own `robots.txt` file with different rules. Default: 'www' 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code:  | Description: Site GUID is missing.


```

### Examples

### Get robots.txt file
```curl
curl -X GET https://www.wixapis.com/promote-seo-txt-file-server/v2/robots?subdomain=www \
    -H 'Authorization: <AUTH>' \
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.txtFileServer.RobotsServiceV2.getRobotsTxt(options)
 Description: Retrieves the `robots.txt` file entity.
 Method parameters:
   param name: options | type: GetRobotsTxtOptions  none 
        - name: subdomain | type: string | description: Subdomain of the requested `robots.txt file`. For example, `www`, `es`, `fr`. Default: `www`. 
 Return type: PROMISE<GetRobotsTxtResponse>
  - name: robotsTxt | type: RobotsTxt | description: Retrieved `robots.txt` file entity. 
     - name: content | type: string | description: Full text content of the `robots.txt` file. 
     - name: default | type: boolean | description: Whether this `robots.txt` file uses Wix's [default content](https://support.wix.com/en/article/editing-your-sites-robotstxt-file). 
     - name: subdomain | type: string | description: If applicable, target subdomain for the `robots.txt` file. For example, a site can have multiple subdomains like `www.example.com`, `es.example.com`, `fr.example.com`. Each subdomain can have its own `robots.txt` file with different rules. Default: 'www' 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code:  | Description: Site GUID is missing.


```

### Examples

### getRobotsTxt
```javascript
import { robotsTxt } from '@wix/seo';

async function getRobotsTxt(options) {
  const response = await robotsTxt.getRobotsTxt(options);
};
```

### getRobotsTxt (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { robotsTxt } from '@wix/seo';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { robotsTxt },
  // Include the auth strategy and host as relevant
});


async function getRobotsTxt(options) {
  const response = await myWixClient.robotsTxt.getRobotsTxt(options);
};
```

---