URL

URL is an input used to save links to websites.

💡 Common url usage

The URL input type can be used to store a link to any web resource, for example:

• Link to Datadog dashboard
• Link to configuration file
• Link to pull request

API definition

Basic

{
  "myUrlInput": {
    "title": "My url input",
    "icon": "My icon",
    "description": "My url input",
    "type": "string",
    "format": "url",
    "default": "https://example.com"
  }
}

Select (Enum)

{
  "myUrlSelectInput": {
    "title": "My url select input",
    "icon": "My icon",
    "description": "My url select input",
    "type": "string",
    "format": "url",
    "enum": ["https://example.com", "https://getport.io"]
  }
}

Array

{
  "myUrlArrayInput": {
    "title": "My url array input",
    "icon": "My icon",
    "description": "My url array input",
    "type": "array",
    "items": {
      "type": "string",
      "format": "url"
    }
  }
}

Check out Port's API reference to learn more.

Terraform definition

Basic

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    string_props = {
      "myUrlInput" = {
        title       = "My url input"
        icon        = "My icon"
        description = "My url input"
        format      = "url"
        default     = "https://example.com"
      }
    }
  }
}

Select (Enum)

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    string_props = {
      "myUrlSelectInput" = {
        title       = "My url select input"
        icon        = "My icon"
        description = "My url select input"
        format      = "url"
        enum        = ["https://example.com", "https://getport.io"]
      }
    }
  }
}

Array

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    array_props = {
      "myUrlArrayInput" = {
        title       = "My url array input"
        icon        = "My icon"
        description = "My url array input"
        format      = "url"
      }
    }
  }
}