> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt.

# Get a mock server

GET https://api.postman.com/mocks/{mockId}

Gets information about a mock server.

Reference: https://learning.postman.com/api-docs/api-reference/mocks/get-mock

## Authentication

- `x-api-key` header (required)

## Servers

- `https://api.postman.com` (https://api.postman.com, default)
- `https://api.eu.postman.com` (https://api.eu.postman.com)

## Request

### Path parameters

- `mockId` (string, required) — The mock's ID.

## Response

### 200

Successful Response

- `mock` (object, optional) — Information about the mock server.
  - `id` (string, optional) — The mock server's ID.
  - `owner` (string, optional) — The ID of mock server's owner.
  - `uid` (string, optional) — The mock server's unique ID.
  - `collection` (string, optional) — The unique ID of the mock's associated collection.
  - `mockUrl` (string, optional) — The mock server URL.
  - `name` (string, optional) — The mock server's name.
  - `config` (object, optional) — Information about the mock server's configuration.
    - `headers` (list of string, optional) — A list of the mock server's headers.
    - `matchBody` (boolean, optional) — If true, match the request body.
    - `matchQueryParams` (boolean, optional) — If true, match query parameters.
    - `matchWildcards` (boolean, optional) — If true, use wildcard variable matching.
    - `delay` (object, optional, nullable) — Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings.
      - `type` (enum, optional) — The type of simulated delay value: - `fixed` — The delay value is a fixed value.
        - Allowed values: `fixed`
      - `preset` (enum, optional) — The simulated fixed network delay value: - `1` — 2G (300 ms). - `2` — 3G (100 ms). The object does not return this value for custom delay values.
        - Allowed values: `1`, `2`
      - `duration` (integer, optional) — The configured delay, in milliseconds.
    - `serverResponseId` (string, optional, nullable) — The ID of mock server's default response for requests. All calls to the mock server will return the defined response.
  - `createdAt` (datetime, optional) — The date and time at which the mock server was created.
  - `updatedAt` (datetime, optional) — The date and time at which the mock server was last updated.
  - `isPublic` (boolean, optional) — If true, the mock server is public and visible to all users. This field does not indicate the mock server's access control status.
  - `deactivated` (boolean, optional) — If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted.
  - `environment` (string, optional) — The mock server's associated environment ID.

## Examples

**Response**

```json
{
  "mock": {
    "id": "e3d951bf-873f-49ac-a658-b2dcb91d3289",
    "owner": "12345678",
    "uid": "12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289",
    "collection": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
    "mockUrl": "https://e3d951bf-873f-49ac-a658-b2dcb91d3289.mock.pstmn.io",
    "name": "Test Mock",
    "config": {
      "headers": [],
      "matchBody": false,
      "matchQueryParams": true,
      "matchWildcards": true,
      "delay": {
        "type": "fixed",
        "duration": 140000
      },
      "serverResponseId": "94d0f5d9-dbdf-4046-9a7d-a11f9b78ac65"
    },
    "createdAt": "2022-07-25T20:54:30.000Z",
    "updatedAt": "2022-07-25T20:54:30.000Z",
    "isPublic": false,
    "deactivated": false,
    "environment": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
  }
}
```

**SDK Code**

```python Successful Response
import requests

url = "https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Successful Response
const url = 'https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Successful Response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Successful Response
require 'uri'
require 'net/http'

url = URI("https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Successful Response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Successful Response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Successful Response
using RestSharp;

var client = new RestClient("https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Successful Response
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.postman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```