Community
- Command Central
- MVP Program
- Monthly Mission
- Blogs
- Groups
- Events
- Media Vault
Products
- Observability
- Network Management
- Application Management
- IT Security
- IT Service Management
- System Management
- Database Management
Content Exchange
- SolarWinds Platform
- Server & Application Monitor
- Database Performance Analyzer
- Server Configuration Monitor
- Network Performance Monitor
- Network Configuration Manager
- SQL Sentry
- Web Help Desk
Free Tools & Trials

SWIS REST API Port Deprecation, did you know?

You may, or may not have noticed within the release notes of 2023.1 and the port requirements document that the use of port 17778 for SWIS API is being deprecated and we recommend that you start using port 17774.

https://documentation.solarwinds.com/en/success_center/orionplatform/content/release_notes/solarwinds_platform_2023-1_release_notes.htm

https://documentation.solarwinds.com/en/success_center/orionplatform/content/core-solarwinds-port-requirements.htm

What is happening?

With the release of 2023.1 the SWIS REST API on port 17778 is deprecated and will be removed in a future version. Note that Agent Management will keep using port 17778.

The release of 2023.1 Introduced a new port 17774 for the SWIS REST API.

This port can now be secured by a customer-defined certificate defined in Centralized Settings. There are 2 new settings to consider.

"CertificateNameForSafequardCommunicationOnSwisRestEndpoint"

The certificate should be stored in the same place as the SolarWinds-Orion certificate (Local Machine - Personal). Use its common name (CN) in the setting

"DisableSwisRestEndpointOnPort17778"

The SWIS REST API on port 17778 can be disabled in Centralized Settings

This is recommended after defining a custom certificate for the new port and updating external integrations and scripts using the old port

Why is this happening?

In short, to improve the certificate management functions across the entire platform. We have been using the same certificate for multiple functions such as HTTPS binding, agent management, the SWIS REST API and more. In order to provide more granular certificate management we will now use a new port for the REST API and allow users to define their own certificate.

The SWIS REST API will no longer be available on port 17778 in a future release and you will need to update your scripts accordingly.

Questions, thoughts, concerns, or comments? Please let me know.

Find more posts tagged with

swis

sdk

API

Comments

jm_sysadmin

Excellent, this will improve our firewall rules

marcrobinson

There are some other benefits here such as simply separating the user/scripted rest api traffic. There have been a few threads about controlling access to the api, and this can definitely be used to observe where the interactions are coming from and limit what machines (yes the discussion has gone that far) can access that ip/port.

MathieuJM

That is a good news. i just have one question : when talking about a future release have you already any idea when this will be changed ?

Have you any target time (current 2024 or 2025) or any target version (2023.3 / 2024.x ) for this full deprecation ?

tony.johnson

CUrrent plans could see this removed in the 2nd half of next year. DO you have any concerns with a specific timeline or challenges moving to the new port?

MathieuJM

Not really we just need to know when the current Rest API will be closed in order to plan our test and script upgrade before that date

k_bolt

So what do I need to do to my Python script which uses orionsdk? How do I get it to use 17774 instead of 17778? Is there some documentation for this you could point me to? Thanks.

MathieuJM

maybe SolarWinds will release a new version of the orionsdk otherwise you have probably to reconfigure the swisclient.py

class SwisClient:
    def __init__(self, hostname, username, password, verify=False, session=None):
        self.url = "https://{}:17778/SolarWinds/InformationService/v3/Json/".\
                format(hostname)
        self._session = session or requests.Session()
        self._session.auth = (username, password)
        self._session.headers.update({'Content-Type': 'application/json'})
        self._session.verify = verify

k_bolt

Thank you Mathieu. I cloned the repo, run the setup.py script and then added the orionsdk-python directory to the Python path with sys.path.append() and all is well for me now.