---
updatedAt: 2026-07-07T21:37:43.000Z
agentTools:
  projectIndex: https://developer.noip.com/llms.txt
---

# Get offline settings.

Get offline settings.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "version": "1.0.0",
    "title": "No-IP API",
    "description": "No-IP API\n"
  },
  "servers": [
    {
      "url": "https://api.noip.com",
      "description": "Production environment. Data at this URL is published to production DNS network."
    }
  ],
  "tags": [
    {
      "name": "records",
      "description": "Manage data related to the DNS name as a whole, or to its enclosed RRSets, not individual rdata.",
      "x-displayName": "records"
    }
  ],
  "paths": {
    "/v1/dns/records/{zone_name}/{name}/offline-settings": {
      "get": {
        "tags": [
          "records"
        ],
        "summary": "Get offline settings.",
        "description": "Get offline settings.",
        "operationId": "v1/dnsGetOfflineSettings",
        "parameters": [
          {
            "name": "zone_name",
            "in": "path",
            "description": "The name of the zone.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ZoneName"
            },
            "example": "example.com"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The DNS name, not including the zone portion.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Name"
            },
            "example": "dns-name"
          }
        ],
        "responses": {
          "200": {
            "description": "success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/OfflineSettings"
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Warning"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "unauthorized (code: 2465)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (code: 2510)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          },
          {
            "basic": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "basic",
        "description": "Put your API key in the password field and leave the username field blank. If your client requires a username, enter 'user'."
      },
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "required": [
          "id",
          "code",
          "title"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "a unique code to identify this error instance"
          },
          "code": {
            "type": "string",
            "description": "an application-specific error code"
          },
          "title": {
            "type": "string",
            "description": "an application-specific text describing the code."
          },
          "detail": {
            "type": [
              "string",
              "null"
            ],
            "description": "Specific information about why this code was emitted."
          },
          "location": {
            "type": [
              "string",
              "null"
            ],
            "description": "Specific information about where this code was emitted."
          },
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "Detailed information about where this code was emitted."
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Warning"
            }
          }
        }
      },
      "Name": {
        "type": "string",
        "description": "The DNS name, not including the zone portion.",
        "example": "dns-name"
      },
      "OfflineAction": {
        "type": "string",
        "enum": [
          "no_action",
          "ip",
          "web_redirect",
          "page"
        ]
      },
      "OfflineSettings": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "$ref": "#/components/schemas/OfflineAction",
            "description": "Action when offline"
          },
          "ip": {
            "type": [
              "string",
              "null"
            ],
            "description": "Ip address used when action is `ip`"
          },
          "web_redirect": {
            "type": [
              "string",
              "null"
            ],
            "description": "Url to redirect used when action is `url`"
          },
          "page_title": {
            "type": [
              "string",
              "null"
            ],
            "description": "Page title when action is `page`"
          },
          "page_text": {
            "type": [
              "string",
              "null"
            ],
            "description": "Page text when action is `page`"
          },
          "page_email": {
            "type": [
              "string",
              "null"
            ],
            "description": "Page contact email when action is `page`"
          },
          "page_logo_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Page logo when action is `page`"
          }
        }
      },
      "Warning": {
        "type": "object",
        "description": "The Warning error type",
        "required": [
          "code",
          "title"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "A code for this warning."
          },
          "title": {
            "type": "string",
            "description": "A title for this warning."
          },
          "detail": {
            "type": [
              "string",
              "null"
            ],
            "description": "Contextual information about this warning."
          }
        }
      },
      "ZoneName": {
        "type": "string",
        "description": "The name of the zone.",
        "example": "example.com"
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Eureka API",
      "tags": [
        "clients",
        "DDNS Keys"
      ]
    },
    {
      "name": "No-IP DNS API",
      "tags": [
        "zones",
        "zone_authorities",
        "records",
        "meta"
      ]
    }
  ]
}
```