> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Creates an uptime check.

> The check starts running as soon as it is created: it is scheduled in the monitoring region
named by `RegionId`, the same way the app schedules one.
            
`Target` has to match `TypeId` - ICMP takes `Ip`, TCP takes `Ip` and
`Port`, HTTP takes `Url` - and sending a field belonging to another type is
rejected rather than ignored.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/uptime
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/uptime:
    post:
      tags:
        - Assets
      summary: Creates an uptime check.
      description: "The check starts running as soon as it is created: it is scheduled in the monitoring region\r\nnamed by `RegionId`, the same way the app schedules one.\r\n            \r\n`Target` has to match `TypeId` - ICMP takes `Ip`, TCP takes `Ip` and\r\n`Port`, HTTP takes `Url` - and sending a field belonging to another type is\r\nrejected rather than ignored."
      operationId: post_v1_uptime
      requestBody:
        description: Uptime check details.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CreateUptimeCommand'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUptimeCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateUptimeCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateUptimeCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateUptimeResultBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUptimeResultBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateUptimeResultBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    CreateUptimeCommand:
      type: object
      properties:
        TypeId:
          type: integer
          description: 'What the check does: 1 ICMP, 2 HTTP, 3 TCP. Required.'
          format: int32
          example: 1
        Target:
          $ref: '#/components/schemas/UptimeTarget'
        AdoptClientAssets:
          type: boolean
          description: "Move unassigned devices whose public IP matches this check's address to the check's\r\nclient. Only acted on for ICMP checks that carry both a client and a location; stored\r\neither way."
        ClientId:
          type: integer
          description: "Identifier of the client the check belongs to. When supplied, `LocationId`\r\nis required with it."
          format: int64
          nullable: true
        LocationId:
          type: integer
          description: Identifier of the client location the check belongs to.
          format: int64
          nullable: true
        Description:
          type: string
          description: What the check watches, free text. Max 250 characters.
          nullable: true
        Frequency:
          type: integer
          description: How often the check runs, in minutes. Required.
          format: int32
          example: 1
        NumberOfRetriesAfterFailure:
          type: integer
          description: >-
            How many times a failure is rechecked before the check counts as
            down. Defaults to 2.
          format: int32
          nullable: true
          example: 2
        RegionId:
          type: integer
          description: >-
            Which monitoring region runs the check: 1 Seattle, 2 Sydney, 3 UK, 4
            Frankfurt. Required.
          format: int32
          example: 1
        IspConnectionLink:
          type: string
          description: >-
            Link to the ISP or provider status page for this endpoint. Max 500
            characters.
          nullable: true
        TagIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of tags to apply to the check.
          nullable: true
      additionalProperties: false
      description: "Request body for creating an uptime check. The owning service provider is resolved from the\r\nrequest context, not from the body."
    CreateUptimeResultBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/CreateUptimeResult'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    UptimeTarget:
      type: object
      properties:
        Ip:
          type: string
          description: "Host to ping, for ICMP and TCP checks. ICMP accepts a hostname as well as an address;\r\nTCP requires a parseable address."
          nullable: true
          example: 8.8.8.8
        Port:
          type: integer
          description: Port to connect to, for TCP checks.
          format: int32
          nullable: true
          example: 443
        Url:
          type: string
          description: Address to request, for HTTP checks.
          nullable: true
          example: https://www.google.com
      additionalProperties: false
      description: "What an uptime check points at. Which fields are populated depends on the check type:\r\nICMP uses `Ip`, TCP uses `Ip` and `Port`, HTTP uses\r\n`Url`. The others are null."
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    CreateUptimeResult:
      type: object
      properties:
        Id:
          type: string
          format: uuid
      additionalProperties: false
      description: The identifier of the created uptime check.
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.