Reefwing Session Statistics

Reefwing Session Statistics · GPT 작업

Siterelic API

API for checking the status of a site and pinging a site.

  • POST /upChecks if a site is up or down

    Post request to check the status of a site.

  • POST /pingPing a site

    Post request to ping a site.

원본 API 스키마
{
  "openapi": "3.0.0",
  "info": {
    "title": "Siterelic API",
    "version": "1.0.0",
    "description": "API for checking the status of a site and pinging a site."
  },
  "servers": [
    {
      "url": "https://api.siterelic.com"
    }
  ],
  "components": {
    "schemas": {},
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/up": {
      "post": {
        "operationId": "checkSiteStatus",
        "summary": "Checks if a site is up or down",
        "description": "Post request to check the status of a site.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL of the site to check"
                  },
                  "proxyCountry": {
                    "type": "string",
                    "description": "Proxy country for the request"
                  },
                  "followRedirect": {
                    "type": "boolean",
                    "description": "Whether to follow redirects"
                  }
                },
                "required": [
                  "url"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Site is up",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "apiStatus": {
                      "type": "string"
                    },
                    "apiCode": {
                      "type": "integer"
                    },
                    "message": {
                      "type": "string"
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "url": {
                          "type": "string"
                        },
                        "proxyCountry": {
                          "type": "string"
                        },
                        "followRedirect": {
                          "type": "boolean"
                        },
                        "redirectedURL": {
                          "type": "string"
                        },
                        "test": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "statusCode": {
                          "type": "integer"
                        },
                        "reasonPhrase": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - Access denied"
          },
          "404": {
            "description": "Not Found - The requested resource does not exist"
          }
        }
      }
    },
    "/ping": {
      "post": {
        "operationId": "pingSite",
        "summary": "Ping a site",
        "description": "Post request to ping a site.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL of the site to ping"
                  }
                },
                "required": [
                  "url"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ping successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "apiStatus": {
                      "type": "string"
                    },
                    "apiCode": {
                      "type": "integer"
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "url": {
                          "type": "string"
                        },
                        "test": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "requests": {
                          "type": "integer"
                        },
                        "loss": {
                          "type": "number"
                        },
                        "latency": {
                          "type": "number"
                        },
                        "min": {
                          "type": "number"
                        },
                        "max": {
                          "type": "number"
                        },
                        "avg": {
                          "type": "number"
                        },
                        "stdDev": {
                          "type": "number"
                        },
                        "ip": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - Access denied"
          },
          "404": {
            "description": "Not Found - The requested resource does not exist"
          }
        }
      }
    }
  }
}