v1beta
Double column
curl
API
CLI

Services /

Get security rules

Lists the security rules for the given service.

URL parameters

    • project

      string required

      ID of the project

    • service

      string required

      ID of the service

Response attributes

  • object

    • credentials

      array required

      An array of credentials to access the service.

      • object

        • username

          string required

          The username to access the service

        • password

          string required

          The password to access the service with this username.

        • ports

          array

          An array of names of ports using these credentials

          • string

            The name of a port using these credentials

        • type

          string required

          The type of authentication used

    • policies

      array required

      An array of IP address policies.

      • object

        • addresses

          array required

          An array of IP addresses used for this rule

          • string

            An IP address used by this rule

        • action

          string required

          The action for this rule.

        • ports

          array

          An array of names of ports using these credentials

          • string

            The name of a port using these credentials

API
CLI

GET /v1beta/projects/{project}/services/{service}/security

Example response

200 OK

Details about the security rules for the service.

JSON

{
  "credentials": [
    {
      "username": "admin",
      "password": "password123",
      "ports": [
        "port-1"
      ],
      "type": "basic-auth"
    }
  ],
  "policies": [
    {
      "addresses": [
        "127.0.0.1"
      ],
      "action": "DENY",
      "ports": [
        "port-1"
      ]
    }
  ]
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com